From de37c31ea17d0516b9ea9437d1e57fbddeaf5ea8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Mar 2022 08:51:46 +0000 Subject: [PATCH 01/96] Auto-generated commit 126aefb18e929dfa0f47fd70e4be37a5755642e2 --- CONTRIBUTORS | 28 + LICENSE | 481 +++++++++ NOTICE | 1 + README.md | 224 ++++ index.d.ts | 211 ++++ index.mjs | 4 + index.mjs.map | 1 + stats.html | 2689 +++++++++++++++++++++++++++++++++++++++++++++++++ 8 files changed, 3639 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 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..cc626ac --- /dev/null +++ b/README.md @@ -0,0 +1,224 @@ + + +# Convert + +[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] + +> Convert an array to an array of a different data type. + + + +
+ +
+ + + + + + + +
+ +## Usage + +```javascript +import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +``` + +#### convertArray( arr, dtype ) + +Converts an array to an array of a different data type. + +```javascript +var arr = [ 1.0, 2.0, 3.0 ]; +var out = convertArray( arr, 'float32' ); +// returns [ 1.0, 2.0, 3.0 ] +``` + +The function supports the following data types: + +- `float32`: single-precision floating-point numbers. +- `float64`: double-precision floating-point numbers. +- `complex64`: single-precision complex floating-point numbers. +- `complex128`: double-precision complex floating-point numbers. +- `generic`: values of any type. +- `int16`: signed 16-bit integers. +- `int32`: signed 32-bit integers. +- `int8`: signed 8-bit integers. +- `uint16`: unsigned 16-bit integers. +- `uint32`: unsigned 32-bit integers. +- `uint8`: unsigned 8-bit integers. +- `uint8c`: unsigned clamped 8-bit integers. + +
+ + + + + +
+ +
+ + + + + +
+ +## Examples + + + +```html + + + + + + +``` + +
+ + + + + +
+ +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/array/convert-same`][@stdlib/array/convert-same]: convert an array to the same data type as a second input array. + +
+ + + + + + +
+ +* * * + +## 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/array-convert.svg +[npm-url]: https://npmjs.org/package/@stdlib/array-convert + +[test-image]: https://github.com/stdlib-js/array-convert/actions/workflows/test.yml/badge.svg?branch=main +[test-url]: https://github.com/stdlib-js/array-convert/actions/workflows/test.yml?query=branch:main + +[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-convert/main.svg +[coverage-url]: https://codecov.io/github/stdlib-js/array-convert?branch=main + + + +[umd]: https://github.com/umdjs/umd +[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules + +[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno +[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd +[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm + +[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 + +[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-convert/main/LICENSE + + + +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm + + + +
+ + diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..a4ac08b --- /dev/null +++ b/index.d.ts @@ -0,0 +1,211 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2021 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; +import { Collection } from '@stdlib/types/object'; + +/** +* Converts an array to a `Float64Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'float64' ); +* // returns [ 1.0, 2.0, 3.0, 4.0 ] +*/ +declare function convert( x: Collection, dtype: 'float64' ): Float64Array; + +/** +* Converts an array to a `Float32Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'float32' ); +* // returns [ 1.0, 2.0, 3.0, 4.0 ] +*/ +declare function convert( x: Collection, dtype: 'float32' ): Float32Array; + +/** +* Converts an array to an `Int32Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'int32' ); +* // returns [ 1, 2, 3, 4 ] +*/ +declare function convert( x: Collection, dtype: 'int32' ): Int32Array; + +/** +* Converts an array to an `Int16Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'int16' ); +* // returns [ 1, 2, 3, 4 ] +*/ +declare function convert( x: Collection, dtype: 'int16' ): Int16Array; + +/** +* Converts an array to an `Int8Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'int8' ); +* // returns [ 1, 2, 3, 4 ] +*/ +declare function convert( x: Collection, dtype: 'int8' ): Int8Array; + +/** +* Converts an array to a `Uint32Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'uint32' ); +* // returns [ 1, 2, 3, 4 ] +*/ +declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; + +/** +* Converts an array to a `Uint16Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'uint16' ); +* // returns [ 1, 2, 3, 4 ] +*/ +declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; + +/** +* Converts an array to a `Uint8Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'uint8' ); +* // returns [ 1, 2, 3, 4 ] +*/ +declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; + +/** +* Converts an array to a `Uint8ClampedArray`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'uint8c' ); +* // returns [ 1, 2, 3, 4 ] +*/ +declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; + +/** +* Converts an array to a `Complex128Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'complex128' ); +* // returns +*/ +declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; + +/** +* Converts an array to a `Complex64Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'complex64' ); +* // returns +*/ +declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; + +/** +* Converts an array to an `Array`. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'generic' ); +* // returns [ 1.0, 2.0, 3.0, 4.0 ] +*/ +declare function convert( x: Collection, dtype: 'generic' ): Array; + +/** +* Converts an array to an array of a different data type. +* +* @param x - array to convert +* @param dtype - output data type +* @returns output array +* +* @example +* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; +* var out = convert( arr, 'float64' ); +* // returns [ 1.0, 2.0, 3.0, 4.0 ] +*/ +declare function convert( x: Collection, dtype: DataType ): AnyArray; + + +// EXPORTS // + +export = convert; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..04004ae --- /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/assert-is-collection@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";var m=e,o=r,a=t,l=s,p=n,c=i,j=d;function h(e){return"complex64"===e}function u(e){return"complex128"===e}var b=function(e,r){var t,s,n,i,d,b,g;if(!m(e))throw new TypeError("invalid argument. First argument must be an array-like object. Value: `"+e+"`.");if("generic"===r)return j(e);if(null===(s=a(r)))throw new TypeError("invalid argument. Second argument must be a recognized array data type. Value: `"+r+"`.");return b=e.length,t=h(g=o(e)),d=new s(b),t||u(g)?(n=t?p(e,0):l(e,0),h(r)?(i=p(d,0),c(2*b,n,1,i,1),d):u(r)?(i=l(d,0),c(2*b,n,1,i,1),d):(c(b,n,2,d,1),d)):(t=h(r))||u(r)?(i=t?p(d,0):l(d,0),c(b,e,1,i,2),d):(c(b,e,1,d,1),d)};export{b as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..3d56146 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( 'invalid argument. First argument must be an array-like object. Value: `' + x + '`.' );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( 'invalid argument. Second argument must be a recognized array data type. Value: `' + dtype + '`.' );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],"names":["isCollection","require$$0","getType","require$$1","ctors","require$$2","reinterpret128","require$$3","reinterpret64","require$$4","gcopy","require$$5","copy","require$$6","isComplex64","dtype","isComplex128","lib","x","isc64","ctor","xbuf","obuf","out","len","t","TypeError","length"],"mappings":";;ymBAsBA,IAAIA,EAAeC,EACfC,EAAUC,EACVC,EAAQC,EACRC,EAAiBC,EACjBC,EAAgBC,EAChBC,EAAQC,EACRC,EAAOC,EAoBX,SAASC,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,MC3BVE,EDgDA,SAAkBC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMzB,EAAckB,GACnB,MAAM,IAAIQ,UAAW,0EAA4ER,EAAI,MAGtG,GAAe,YAAVH,EACJ,OAAOH,EAAMM,GAGd,GAAc,QADdE,EAAOhB,EAAOW,IAEb,MAAM,IAAIW,UAAW,mFAAqFX,EAAQ,MAanH,OAVAS,EAAMN,EAAES,OAIRR,EAAQL,EADRW,EAAIvB,EAASgB,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGX,EAAeU,EAAG,GAElBZ,EAAgBY,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOd,EAAee,EAAK,GAC3Bb,EAAW,EAAJc,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOhB,EAAgBiB,EAAK,GAC5Bb,EAAW,EAAJc,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRb,EAAOc,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGX,EAAee,EAAK,GAEpBjB,EAAgBiB,EAAK,GAG7Bb,EAAOc,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRb,EAAOc,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..feffe08 --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + From 9b9889a18ecba27a80b785d88b592a26a56caf51 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 16 Mar 2022 18:04:41 +0000 Subject: [PATCH 02/96] Auto-generated commit 8d3782c20d58e6ccbf36971324cb6ad66a710c35 --- README.md | 14 +++++++------- index.mjs.map | 2 +- package.json | 36 ++++++++++++++++++++++++++++++++++++ stats.html | 2 +- 4 files changed, 45 insertions(+), 9 deletions(-) create mode 100644 package.json diff --git a/README.md b/README.md index cc626ac..e1da459 100644 --- a/README.md +++ b/README.md @@ -197,13 +197,6 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. --> -[umd]: https://github.com/umdjs/umd -[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules - -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm - [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg [chat-url]: https://gitter.im/stdlib-js/stdlib/ @@ -211,6 +204,13 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors +[umd]: https://github.com/umdjs/umd +[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules + +[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno +[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd +[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm + [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-convert/main/LICENSE diff --git a/index.mjs.map b/index.mjs.map index 3d56146..b44b668 100644 --- a/index.mjs.map +++ b/index.mjs.map @@ -1 +1 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( 'invalid argument. First argument must be an array-like object. Value: `' + x + '`.' );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( 'invalid argument. Second argument must be a recognized array data type. Value: `' + dtype + '`.' );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],"names":["isCollection","require$$0","getType","require$$1","ctors","require$$2","reinterpret128","require$$3","reinterpret64","require$$4","gcopy","require$$5","copy","require$$6","isComplex64","dtype","isComplex128","lib","x","isc64","ctor","xbuf","obuf","out","len","t","TypeError","length"],"mappings":";;ymBAsBA,IAAIA,EAAeC,EACfC,EAAUC,EACVC,EAAQC,EACRC,EAAiBC,EACjBC,EAAgBC,EAChBC,EAAQC,EACRC,EAAOC,EAoBX,SAASC,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,MC3BVE,EDgDA,SAAkBC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMzB,EAAckB,GACnB,MAAM,IAAIQ,UAAW,0EAA4ER,EAAI,MAGtG,GAAe,YAAVH,EACJ,OAAOH,EAAMM,GAGd,GAAc,QADdE,EAAOhB,EAAOW,IAEb,MAAM,IAAIW,UAAW,mFAAqFX,EAAQ,MAanH,OAVAS,EAAMN,EAAES,OAIRR,EAAQL,EADRW,EAAIvB,EAASgB,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGX,EAAeU,EAAG,GAElBZ,EAAgBY,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOd,EAAee,EAAK,GAC3Bb,EAAW,EAAJc,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOhB,EAAgBiB,EAAK,GAC5Bb,EAAW,EAAJc,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRb,EAAOc,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGX,EAAee,EAAK,GAEpBjB,EAAgBiB,EAAK,GAG7Bb,EAAOc,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRb,EAAOc,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( 'invalid argument. First argument must be an array-like object. Value: `' + x + '`.' );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( 'invalid argument. Second argument must be a recognized array data type. Value: `' + dtype + '`.' );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],"names":["isCollection","require$$0","getType","require$$1","ctors","require$$2","reinterpret128","require$$3","reinterpret64","require$$4","gcopy","require$$5","copy","require$$6","isComplex64","dtype","isComplex128","lib","x","isc64","ctor","xbuf","obuf","out","len","t","TypeError","length"],"mappings":";;ymBAsBA,IAAIA,EAAeC,EACfC,EAAUC,EACVC,EAAQC,EACRC,EAAiBC,EACjBC,EAAgBC,EAChBC,EAAQC,EACRC,EAAOC,EAoBX,SAASC,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EA6FV,ICxHAE,EDgDA,SAAkBC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMzB,EAAckB,GACnB,MAAM,IAAIQ,UAAW,0EAA4ER,EAAI,MAGtG,GAAe,YAAVH,EACJ,OAAOH,EAAMM,GAGd,GAAc,QADdE,EAAOhB,EAAOW,IAEb,MAAM,IAAIW,UAAW,mFAAqFX,EAAQ,MAanH,OAVAS,EAAMN,EAAES,OAIRR,EAAQL,EADRW,EAAIvB,EAASgB,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGX,EAAeU,EAAG,GAElBZ,EAAgBY,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOd,EAAee,EAAK,GAC3Bb,EAAW,EAAJc,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOhB,EAAgBiB,EAAK,GAC5Bb,EAAW,EAAJc,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRb,EAAOc,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGX,EAAee,EAAK,GAEpBjB,EAAgBiB,EAAK,GAG7Bb,EAAOc,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRb,EAAOc,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..5666bba --- /dev/null +++ b/package.json @@ -0,0 +1,36 @@ +{ + "name": "@stdlib/array-convert", + "version": "0.0.0", + "description": "Convert an array to an array of a different data type.", + "license": "Apache-2.0", + "type": "module", + "main": "./index.mjs", + "homepage": "https://stdlib.io", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/array-convert.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "keywords": [ + "stdlib", + "stdtypes", + "types", + "data", + "structure", + "array", + "typed", + "typed array", + "typed-array", + "convert", + "cast", + "transform", + "copy", + "duplicate" + ], + "funding": { + "type": "patreon", + "url": "https://www.patreon.com/athan" + } +} diff --git a/stats.html b/stats.html index feffe08..63b81f3 100644 --- a/stats.html +++ b/stats.html @@ -2669,7 +2669,7 @@ - - - - From bad1c627d7a91946837aeef108c6bf5b590eb6c6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Jul 2022 04:32:05 +0000 Subject: [PATCH 06/96] 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 | 41 +- benchmark/benchmark.js | 329 --- benchmark/benchmark.length.js | 135 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 -- benchmark/python/numpy/benchmark.py | 136 -- branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 -- package.json | 92 +- stats.html | 2689 +++++++++++++++++++++ test/test.js | 506 ---- 41 files changed, 2714 insertions(+), 4669 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 9c06f78..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-06-30T23:01:53.960Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..ffb6c4f --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..db2c6e4 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;msBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 6bd3896..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0dc9b63 --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From b11eb01b35398b8d13a156f6363bfdaa1c854397 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Jul 2022 18:33:37 +0000 Subject: [PATCH 07/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..92bf7b1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00F2a', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00F2b', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 61ec97b..6bd3896 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.x", "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x" }, "devDependencies": { From 88f9f17f8c5ee0ca110b2a1fb7d2a3d789d8851e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Jul 2022 09:09:40 +0000 Subject: [PATCH 08/96] Remove files --- index.d.ts | 211 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2905 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index ffb6c4f..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index db2c6e4..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;msBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0dc9b63..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From a150b28ad49f2637a356fce4a3ff606d3228dce0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Jul 2022 09:10:29 +0000 Subject: [PATCH 09/96] 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 | 41 +- benchmark/benchmark.js | 329 --- benchmark/benchmark.length.js | 135 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 -- benchmark/python/numpy/benchmark.py | 136 -- branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 -- package.json | 92 +- stats.html | 2689 +++++++++++++++++++++ test/test.js | 506 ---- 41 files changed, 2714 insertions(+), 4669 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 62e6a74..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-07-01T01:49:09.667Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..ffb6c4f --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..db2c6e4 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;msBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 6bd3896..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a50ac1c --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 9312a6c94eb3861c2643fadf83cfc95d2e5895e2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 Jul 2022 18:53:02 +0000 Subject: [PATCH 10/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..92bf7b1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00F2a', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00F2b', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 61ec97b..6bd3896 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.x", "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x" }, "devDependencies": { From 92c7ec9f7945a52690d95e5b5c97f95e52b373f5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 Jul 2022 19:18:09 +0000 Subject: [PATCH 11/96] Remove files --- index.d.ts | 211 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2905 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index ffb6c4f..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index db2c6e4..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;msBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a50ac1c..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 40124e91cea3ce880e4ca3cfe347b62cd853c6d0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 Jul 2022 19:19:17 +0000 Subject: [PATCH 12/96] 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 | 41 +- benchmark/benchmark.js | 329 --- benchmark/benchmark.length.js | 135 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 -- benchmark/python/numpy/benchmark.py | 136 -- branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 -- package.json | 92 +- stats.html | 2689 +++++++++++++++++++++ test/test.js | 506 ---- 40 files changed, 2714 insertions(+), 4634 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..ffb6c4f --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..db2c6e4 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;msBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 6bd3896..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..6ffc1aa --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 2d84ce4109d73a614b85563f03e9e4e9cafc35a8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Aug 2022 04:03:21 +0000 Subject: [PATCH 13/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..92bf7b1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00F2a', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00F2b', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 61ec97b..6bd3896 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.x", "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x" }, "devDependencies": { From 068ad025055cee6b8b999401d59e8b1a0e797b4b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Aug 2022 14:56:36 +0000 Subject: [PATCH 14/96] Remove files --- index.d.ts | 211 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2905 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index ffb6c4f..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index db2c6e4..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;msBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 6ffc1aa..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From b095f05b7bab5061b7f6a000e436042736e7faa4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Aug 2022 14:57:36 +0000 Subject: [PATCH 15/96] 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 | 41 +- benchmark/benchmark.js | 329 --- benchmark/benchmark.length.js | 135 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 -- benchmark/python/numpy/benchmark.py | 136 -- branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 -- package.json | 92 +- stats.html | 2689 +++++++++++++++++++++ test/test.js | 506 ---- 41 files changed, 2714 insertions(+), 4708 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 979eb4c..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-08-01T01:50:48.598Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8a4fe3e --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..d93305b --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;0sBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 6bd3896..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..9c188e9 --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 6d7a32e8e6f753296e7b0221f8a90541791ec2fa Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Sep 2022 03:54:41 +0000 Subject: [PATCH 16/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..92bf7b1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00F2a', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00F2b', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 61ec97b..6bd3896 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.x", "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x" }, "devDependencies": { From e019e7c681f7e69639ada8c3ed195ef5fe28da8f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Sep 2022 17:36:22 +0000 Subject: [PATCH 17/96] Remove files --- index.d.ts | 211 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2905 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8a4fe3e..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index d93305b..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;0sBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 9c188e9..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From e62d6c27960eaa72c0d0df4f649738169fafe089 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Sep 2022 17:37:15 +0000 Subject: [PATCH 18/96] 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 | 41 +- benchmark/benchmark.js | 329 --- benchmark/benchmark.length.js | 135 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 -- benchmark/python/numpy/benchmark.py | 136 -- branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 -- package.json | 92 +- stats.html | 2689 +++++++++++++++++++++ test/test.js | 506 ---- 41 files changed, 2714 insertions(+), 4724 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 3a8f577..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-09-01T01:51:45.915Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8a4fe3e --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..d93305b --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;0sBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 6bd3896..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..ca3aeed --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 047ace17af5e552c85a9553bb983ee83a87c85a0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Oct 2022 02:23:37 +0000 Subject: [PATCH 19/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..92bf7b1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00F2a', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00F2b', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 61ec97b..6bd3896 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.x", "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x" }, "devDependencies": { From 9e14d602c7e1b3c4ef03fc4c2a499340c9211b5d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Oct 2022 16:07:03 +0000 Subject: [PATCH 20/96] Remove files --- index.d.ts | 211 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2905 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8a4fe3e..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index d93305b..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;0sBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index ca3aeed..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 7537467a2dd4f30d9736238cf0ea4ad2f1ce5bc4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Oct 2022 16:08:07 +0000 Subject: [PATCH 21/96] 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 | 41 +- benchmark/benchmark.js | 329 --- benchmark/benchmark.length.js | 135 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 -- benchmark/python/numpy/benchmark.py | 136 -- branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 -- package.json | 92 +- stats.html | 2689 +++++++++++++++++++++ test/test.js | 506 ---- 41 files changed, 2714 insertions(+), 4724 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 a24701f..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-10-01T02:20:15.396Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8a4fe3e --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..d93305b --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;0sBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 6bd3896..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..810ed7c --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 7e780acc3423048a6ae7650b3f60f875f9312f60 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Nov 2022 04:07:27 +0000 Subject: [PATCH 22/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..92bf7b1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00F2a', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00F2b', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 61ec97b..6bd3896 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.x", "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x" }, "devDependencies": { From 7a3ff9baac99d5e5951396b09a7cbdf5c47c1d6d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Nov 2022 12:18:03 +0000 Subject: [PATCH 23/96] Remove files --- index.d.ts | 211 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2905 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8a4fe3e..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index d93305b..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;0sBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,EAkBV,SAASC,EAAcD,GACtB,MAAmB,eAAVA,EAqBV,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 810ed7c..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From b6f1aa8b1fec8c6da4168e2cc0d715b4fbd12670 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Nov 2022 12:19:07 +0000 Subject: [PATCH 24/96] 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 | 41 +- benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 4044 +++++++++++++++++++++ test/test.js | 506 --- 41 files changed, 4069 insertions(+), 4724 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 22d5c43..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-11-01T02:04:45.552Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 d27a552..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: '11 11 * * 5' - - # 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8a4fe3e --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8e01c50 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;0sBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 6bd3896..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2e42ef4 --- /dev/null +++ b/stats.html @@ -0,0 +1,4044 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 3ffea1cde171b722c9bb9793ca0bbb42fdcdbefb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 4 Nov 2022 00:46:13 +0000 Subject: [PATCH 25/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..92bf7b1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00F2a', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00F2b', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 61ec97b..6bd3896 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.x", "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x" }, "devDependencies": { From e6a98ea442f62bbd7918ad2390f99919a6786044 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 4 Nov 2022 14:53:33 +0000 Subject: [PATCH 26/96] Remove files --- index.d.ts | 211 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4044 ------------------------------------------------- 4 files changed, 4260 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8a4fe3e..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8e01c50..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;0sBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2e42ef4..0000000 --- a/stats.html +++ /dev/null @@ -1,4044 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 59a7cb665404c932c925b34f733f52b803faa039 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 4 Nov 2022 14:54:34 +0000 Subject: [PATCH 27/96] 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 | 41 +- benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 4044 +++++++++++++++++++++ test/test.js | 506 --- 41 files changed, 4069 insertions(+), 4745 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 bca9779..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-11-03T23:11:59.651Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 d27a552..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: '11 11 * * 5' - - # 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c1839bd --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4d8de56 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 6bd3896..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a2bbaee --- /dev/null +++ b/stats.html @@ -0,0 +1,4044 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 3594dbbc21d8308407cb9990f2d3b67595914da5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Dec 2022 04:48:14 +0000 Subject: [PATCH 28/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..92bf7b1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00F2a', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00F2b', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index fd69ca4..02501c0 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.x", "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x" }, "devDependencies": { From 133efca64102633760d998bbcbe1994c04551970 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Dec 2022 15:58:28 +0000 Subject: [PATCH 29/96] Remove files --- index.d.ts | 211 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4044 ------------------------------------------------- 4 files changed, 4260 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c1839bd..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4d8de56..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection' ;\nimport getType from '@stdlib/array-dtype' ;\nimport ctors from '@stdlib/array-ctors' ;\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128' ;\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport gcopy from '@stdlib/blas-base-gcopy' ;\nimport copy from '@stdlib/array-base-copy' ;\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a2bbaee..0000000 --- a/stats.html +++ /dev/null @@ -1,4044 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 763b4cbc5d25a8b3a9532bf378cd1d9fbad1181a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Dec 2022 15:59:35 +0000 Subject: [PATCH 30/96] 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 | 41 +- benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 4044 +++++++++++++++++++++ test/test.js | 506 --- 41 files changed, 4069 insertions(+), 4750 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 17b2ee5..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-12-01T02:59:31.777Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 d27a552..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: '11 11 * * 5' - - # 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c1839bd --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..805fa5d --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 02501c0..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..5cb6608 --- /dev/null +++ b/stats.html @@ -0,0 +1,4044 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 92ccb61c53b094510e05c56fd9a5d19f1cd39a7a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Feb 2023 04:20:11 +0000 Subject: [PATCH 31/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..92bf7b1 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00F2a', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00F2b', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 11d0968..31f0421 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.x", "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x" }, "devDependencies": { From f2998679c688365f89c344481d9cd17676c64aaf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Feb 2023 13:18:15 +0000 Subject: [PATCH 32/96] Remove files --- index.d.ts | 211 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4044 ------------------------------------------------- 4 files changed, 4260 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c1839bd..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 805fa5d..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5cb6608..0000000 --- a/stats.html +++ /dev/null @@ -1,4044 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 6261be28f8a4e4c0bd29672806df667c3a2aa779 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Feb 2023 13:19:14 +0000 Subject: [PATCH 33/96] 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 | 41 +- benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 506 -- 41 files changed, 6202 insertions(+), 4761 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 1d5ccad..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-02-01T02:44:35.751Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 d27a552..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: '11 11 * * 5' - - # 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cde0269..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/array/convert" -click B href "https://github.com/stdlib-js/array-convert/tree/main" -click C href "https://github.com/stdlib-js/array-convert/tree/production" -click D href "https://github.com/stdlib-js/array-convert/tree/esm" -click E href "https://github.com/stdlib-js/array-convert/tree/deno" -click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 58aa89a..a4ac08b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3770033 --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..805fa5d --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 92bf7b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00F2a', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00F2b', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 31f0421..4c7289c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.x", - "@stdlib/array-ctors": "^0.0.x", - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/assert-is-collection": "^0.0.x", - "@stdlib/blas-base-gcopy": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.x", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.x", - "@stdlib/array-complex64": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-float32": "^0.0.x", - "@stdlib/array-float64": "^0.0.x", - "@stdlib/array-int16": "^0.0.x", - "@stdlib/array-int32": "^0.0.x", - "@stdlib/array-int8": "^0.0.x", - "@stdlib/array-uint16": "^0.0.x", - "@stdlib/array-uint32": "^0.0.x", - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/array-uint8c": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/assert-is-complex128": "^0.0.x", - "@stdlib/assert-is-complex128array": "^0.0.x", - "@stdlib/assert-is-complex64": "^0.0.x", - "@stdlib/assert-is-complex64array": "^0.0.x", - "@stdlib/assert-is-float32array": "^0.0.x", - "@stdlib/assert-is-float64array": "^0.0.x", - "@stdlib/assert-is-int16array": "^0.0.x", - "@stdlib/assert-is-int32array": "^0.0.x", - "@stdlib/assert-is-int8array": "^0.0.x", - "@stdlib/assert-is-uint16array": "^0.0.x", - "@stdlib/assert-is-uint32array": "^0.0.x", - "@stdlib/assert-is-uint8array": "^0.0.x", - "@stdlib/assert-is-uint8clampedarray": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/complex-imag": "^0.0.x", - "@stdlib/complex-imagf": "^0.0.x", - "@stdlib/complex-real": "^0.0.x", - "@stdlib/complex-realf": "^0.0.x", - "@stdlib/math-base-special-pow": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f61d904 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 81003eeb90651458b1002f2e883a4c95aa3bf345 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:28:35 +0000 Subject: [PATCH 34/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..ae890d6 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O,GW', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P,Mp', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 0223195..bd4b586 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.8", "@stdlib/strided-base-reinterpret-complex128": "^0.0.2", "@stdlib/strided-base-reinterpret-complex64": "^0.0.2", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14" }, "devDependencies": { From eb8d7abbbcf07f5f82ab4ef40f8f2794e090de11 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:34:15 +0000 Subject: [PATCH 35/96] Remove files --- index.d.ts | 211 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6393 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 a4ac08b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,211 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; -import { Collection } from '@stdlib/types/object'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3770033..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,a,f,b,x,g;if(!e(l))throw new TypeError(n("00F2a",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00F2b",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(a=c?i(l,0):s(l,0),o(j)?(f=i(b,0),d(2*x,a,1,f,1),b):p(j)?(f=s(b,0),d(2*x,a,1,f,1),b):(d(x,a,2,b,1),b)):(c=o(j))||p(j)?(f=c?i(b,0):s(b,0),d(x,l,1,f,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 805fa5d..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00F2a', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00F2b', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f61d904..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From c2e289af1cb31c349c1fc79cc513e87da9e97e90 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:35:31 +0000 Subject: [PATCH 36/96] Auto-generated commit --- .editorconfig | 181 - .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 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 506 -- 43 files changed, 6202 insertions(+), 4901 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 d27a552..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: '11 11 * * 5' - - # 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 03c8991..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 24b7355..b7e84d3 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..10c7f6a --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,f,a,b,x,g;if(!e(l))throw new TypeError(n("00V2O,GW",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P,Mp",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(f=c?i(l,0):s(l,0),o(j)?(a=i(b,0),d(2*x,f,1,a,1),b):p(j)?(a=s(b,0),d(2*x,f,1,a,1),b):(d(x,f,2,b,1),b)):(c=o(j))||p(j)?(a=c?i(b,0):s(b,0),d(x,l,1,a,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fe2a84a --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O,GW', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P,Mp', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,WAAYV,IAG1C,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,WAAYb,IAa1C,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index ae890d6..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O,GW', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P,Mp', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index bd4b586..396af91 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.2", - "@stdlib/array-ctors": "^0.0.6", - "@stdlib/array-dtype": "^0.0.6", - "@stdlib/assert-is-collection": "^0.0.8", - "@stdlib/blas-base-gcopy": "^0.0.8", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.2", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.6", - "@stdlib/array-complex64": "^0.0.6", - "@stdlib/array-dtypes": "^0.0.6", - "@stdlib/array-filled-by": "^0.0.2", - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-int16": "^0.0.6", - "@stdlib/array-int32": "^0.0.6", - "@stdlib/array-int8": "^0.0.6", - "@stdlib/array-uint16": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/array-uint8": "^0.0.7", - "@stdlib/array-uint8c": "^0.0.8", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/assert-is-complex128": "^0.0.7", - "@stdlib/assert-is-complex128array": "^0.0.7", - "@stdlib/assert-is-complex64": "^0.0.7", - "@stdlib/assert-is-complex64array": "^0.0.7", - "@stdlib/assert-is-float32array": "^0.0.8", - "@stdlib/assert-is-float64array": "^0.0.8", - "@stdlib/assert-is-int16array": "^0.0.8", - "@stdlib/assert-is-int32array": "^0.0.8", - "@stdlib/assert-is-int8array": "^0.0.8", - "@stdlib/assert-is-uint16array": "^0.0.8", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/assert-is-uint8array": "^0.0.8", - "@stdlib/assert-is-uint8clampedarray": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/complex-imag": "^0.0.7", - "@stdlib/complex-imagf": "^0.0.1", - "@stdlib/complex-real": "^0.0.7", - "@stdlib/complex-realf": "^0.0.1", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-discrete-uniform": "^0.0.6", - "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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..339fc41 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 55e6babf3cd4877d20121cb92c4431ff4f20bb16 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 19 Aug 2023 01:37:47 +0000 Subject: [PATCH 37/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..ae890d6 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O,GW', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P,Mp', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 0223195..bd4b586 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.0.8", "@stdlib/strided-base-reinterpret-complex128": "^0.0.2", "@stdlib/strided-base-reinterpret-complex64": "^0.0.2", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14" }, "devDependencies": { From 6a6021af19e62b832eeffdad43f6d62c82798570 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 19 Aug 2023 01:45:19 +0000 Subject: [PATCH 38/96] Remove files --- index.d.ts | 210 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6392 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 b7e84d3..0000000 --- a/index.d.ts +++ /dev/null @@ -1,210 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 10c7f6a..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,f,a,b,x,g;if(!e(l))throw new TypeError(n("00V2O,GW",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P,Mp",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(f=c?i(l,0):s(l,0),o(j)?(a=i(b,0),d(2*x,f,1,a,1),b):p(j)?(a=s(b,0),d(2*x,f,1,a,1),b):(d(x,f,2,b,1),b)):(c=o(j))||p(j)?(a=c?i(b,0):s(b,0),d(x,l,1,a,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fe2a84a..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O,GW', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P,Mp', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,WAAYV,IAG1C,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,WAAYb,IAa1C,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 339fc41..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e510ac23f7c2172b0ae928191430a706c44d7744 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 19 Aug 2023 01:46:25 +0000 Subject: [PATCH 39/96] Auto-generated commit --- .editorconfig | 181 - .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 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 506 -- 43 files changed, 6202 insertions(+), 4901 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 d27a552..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: '11 11 * * 5' - - # 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 + + ```
@@ -161,7 +154,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -223,7 +216,7 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 03c8991..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 aed997b..0cc341f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..10c7f6a --- /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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,f,a,b,x,g;if(!e(l))throw new TypeError(n("00V2O,GW",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P,Mp",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(f=c?i(l,0):s(l,0),o(j)?(a=i(b,0),d(2*x,f,1,a,1),b):p(j)?(a=s(b,0),d(2*x,f,1,a,1),b):(d(x,f,2,b,1),b)):(c=o(j))||p(j)?(a=c?i(b,0):s(b,0),d(x,l,1,a,2),b):(d(x,l,1,b,1),b)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fe2a84a --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O,GW', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P,Mp', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,WAAYV,IAG1C,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,WAAYb,IAa1C,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index ae890d6..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O,GW', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P,Mp', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index bd4b586..396af91 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.6", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.0.2", - "@stdlib/array-ctors": "^0.0.6", - "@stdlib/array-dtype": "^0.0.6", - "@stdlib/assert-is-collection": "^0.0.8", - "@stdlib/blas-base-gcopy": "^0.0.8", - "@stdlib/strided-base-reinterpret-complex128": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex64": "^0.0.2", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.0.6", - "@stdlib/array-complex64": "^0.0.6", - "@stdlib/array-dtypes": "^0.0.6", - "@stdlib/array-filled-by": "^0.0.2", - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-int16": "^0.0.6", - "@stdlib/array-int32": "^0.0.6", - "@stdlib/array-int8": "^0.0.6", - "@stdlib/array-uint16": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/array-uint8": "^0.0.7", - "@stdlib/array-uint8c": "^0.0.8", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/assert-is-complex128": "^0.0.7", - "@stdlib/assert-is-complex128array": "^0.0.7", - "@stdlib/assert-is-complex64": "^0.0.7", - "@stdlib/assert-is-complex64array": "^0.0.7", - "@stdlib/assert-is-float32array": "^0.0.8", - "@stdlib/assert-is-float64array": "^0.0.8", - "@stdlib/assert-is-int16array": "^0.0.8", - "@stdlib/assert-is-int32array": "^0.0.8", - "@stdlib/assert-is-int8array": "^0.0.8", - "@stdlib/assert-is-uint16array": "^0.0.8", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/assert-is-uint8array": "^0.0.8", - "@stdlib/assert-is-uint8clampedarray": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/complex-imag": "^0.0.7", - "@stdlib/complex-imagf": "^0.0.1", - "@stdlib/complex-real": "^0.0.7", - "@stdlib/complex-realf": "^0.0.1", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-discrete-uniform": "^0.0.6", - "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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d5b34a8 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From ed9f0b965baad08cba09d7479f123a172c19a360 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 22:29:23 +0000 Subject: [PATCH 40/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..ae890d6 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O,GW', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P,Mp', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index f23bdc8..29061bf 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.1.0", "@stdlib/strided-base-reinterpret-complex128": "^0.1.0", "@stdlib/strided-base-reinterpret-complex64": "^0.1.0", - "@stdlib/string-format": "^0.1.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.0", "@stdlib/types": "^0.1.0" }, "devDependencies": { From 9fb53f38b83537e970a1c903a95befb6212cb50e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 22:51:21 +0000 Subject: [PATCH 41/96] Remove files --- index.d.ts | 210 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6392 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 0cc341f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,210 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 10c7f6a..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/assert-is-collection@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.0.8-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,f,a,b,x,g;if(!e(l))throw new TypeError(n("00V2O,GW",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P,Mp",j));return x=l.length,c=o(g=t(l)),b=new h(x),c||p(g)?(f=c?i(l,0):s(l,0),o(j)?(a=i(b,0),d(2*x,f,1,a,1),b):p(j)?(a=s(b,0),d(2*x,f,1,a,1),b):(d(x,f,2,b,1),b)):(c=o(j))||p(j)?(a=c?i(b,0):s(b,0),d(x,l,1,a,2),b):(d(x,l,1,b,1),b)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fe2a84a..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O,GW', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P,Mp', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;itBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,WAAYV,IAG1C,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,WAAYb,IAa1C,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d5b34a8..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 43481f51a91b785c440f164f0b82a995f32e2249 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 22:54:14 +0000 Subject: [PATCH 42/96] 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 | 41 +- benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 506 -- 44 files changed, 6202 insertions(+), 4936 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 739ad34..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/array/convert) 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 d27a552..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: '11 11 * * 5' - - # 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 + + ```
@@ -172,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -234,7 +227,7 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 03c8991..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 aed997b..0cc341f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..336d620 --- /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/assert-is-collection@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,f,v,a,b,x;if(!e(l))throw new TypeError(n("00V2O,GW",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P,Mp",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(f=c?i(l,0):s(l,0),o(j)?(v=i(a,0),d(2*b,f,1,v,1),a):p(j)?(v=s(a,0),d(2*b,f,1,v,1),a):(d(b,f,2,a,1),a)):(c=o(j))||p(j)?(v=c?i(a,0):s(a,0),d(b,l,1,v,2),a):(d(b,l,1,a,1),a)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..f6a981d --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O,GW', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P,Mp', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;ovBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,WAAYV,IAG1C,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,WAAYb,IAa1C,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index ae890d6..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O,GW', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P,Mp', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 29061bf..a1729ce 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.1.0", - "@stdlib/array-ctors": "^0.1.0", - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/blas-base-gcopy": "^0.1.0", - "@stdlib/strided-base-reinterpret-complex128": "^0.1.0", - "@stdlib/strided-base-reinterpret-complex64": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0", - "@stdlib/types": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.1.0", - "@stdlib/array-complex64": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-float32": "^0.1.0", - "@stdlib/array-float64": "^0.1.0", - "@stdlib/array-int16": "^0.1.0", - "@stdlib/array-int32": "^0.1.0", - "@stdlib/array-int8": "^0.1.0", - "@stdlib/array-uint16": "^0.1.0", - "@stdlib/array-uint32": "^0.1.0", - "@stdlib/array-uint8": "^0.1.0", - "@stdlib/array-uint8c": "^0.1.0", - "@stdlib/assert-is-array": "^0.1.0", - "@stdlib/assert-is-complex128": "^0.1.0", - "@stdlib/assert-is-complex128array": "^0.1.0", - "@stdlib/assert-is-complex64": "^0.1.0", - "@stdlib/assert-is-complex64array": "^0.1.0", - "@stdlib/assert-is-float32array": "^0.1.0", - "@stdlib/assert-is-float64array": "^0.1.0", - "@stdlib/assert-is-int16array": "^0.1.0", - "@stdlib/assert-is-int32array": "^0.1.0", - "@stdlib/assert-is-int8array": "^0.1.0", - "@stdlib/assert-is-uint16array": "^0.1.0", - "@stdlib/assert-is-uint32array": "^0.1.0", - "@stdlib/assert-is-uint8array": "^0.1.0", - "@stdlib/assert-is-uint8clampedarray": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/complex-imag": "^0.1.0", - "@stdlib/complex-imagf": "^0.1.0", - "@stdlib/complex-real": "^0.1.0", - "@stdlib/complex-realf": "^0.1.0", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..adb7f39 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From f6f7402356e4659fbbabc1c1d453e91352b1356c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 22:55:02 +0000 Subject: [PATCH 43/96] Update README.md for ESM bundle v0.1.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a3c389e..76863ae 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.1.0-esm/index.mjs'; ``` #### convertArray( arr, dtype ) @@ -109,7 +109,7 @@ The function supports the following data types: var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform' ).factory; import filledarrayBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled-by@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.1.0-esm/index.mjs'; // Create a generic array: var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); From 5bfc3e343e74cc88e43d6c1d5dfa5ff8960ac495 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 22:55:03 +0000 Subject: [PATCH 44/96] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 76863ae..983655d 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-convert/tags). For example, + ```javascript import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.1.0-esm/index.mjs'; ``` @@ -109,7 +114,7 @@ The function supports the following data types: var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform' ).factory; import filledarrayBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled-by@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.1.0-esm/index.mjs'; +import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; // Create a generic array: var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); From 8f6696071aca1f6b6a4aaf20d134ec3a0f778bfd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Oct 2023 18:40:54 +0000 Subject: [PATCH 45/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..ae890d6 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O,GW', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P,Mp', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index f23bdc8..29061bf 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.1.0", "@stdlib/strided-base-reinterpret-complex128": "^0.1.0", "@stdlib/strided-base-reinterpret-complex64": "^0.1.0", - "@stdlib/string-format": "^0.1.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.0", "@stdlib/types": "^0.1.0" }, "devDependencies": { From 9a0e1225a6eb61fc460935f8ddc8a3bd8b5dc654 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 3 Oct 2023 05:23:16 +0000 Subject: [PATCH 46/96] Remove files --- index.d.ts | 210 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6392 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 0cc341f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,210 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 336d620..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/assert-is-collection@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,f,v,a,b,x;if(!e(l))throw new TypeError(n("00V2O,GW",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P,Mp",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(f=c?i(l,0):s(l,0),o(j)?(v=i(a,0),d(2*b,f,1,v,1),a):p(j)?(v=s(a,0),d(2*b,f,1,v,1),a):(d(b,f,2,a,1),a)):(c=o(j))||p(j)?(v=c?i(a,0):s(a,0),d(b,l,1,v,2),a):(d(b,l,1,a,1),a)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index f6a981d..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O,GW', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P,Mp', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;ovBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,WAAYV,IAG1C,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,WAAYb,IAa1C,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index adb7f39..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7ae53ff3fde75f4899d10af17c33eaab08bb2b7c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 3 Oct 2023 05:27:15 +0000 Subject: [PATCH 47/96] 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 | 41 +- benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 506 -- test/test.js | 506 -- 46 files changed, 6202 insertions(+), 5501 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 e9594ae..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-10-01T06:10:10.742Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 344114b..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: '11 11 * * 5' - - # 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 + + ```
@@ -172,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -234,7 +227,7 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 03c8991..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 aed997b..0cc341f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c8cb6ca --- /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/assert-is-collection@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@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 d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O,GW",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P,Mp",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..9fe15d3 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O,GW', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P,Mp', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,WAAYV,IAG1C,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,WAAYb,IAa1C,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index ae890d6..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O,GW', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P,Mp', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 29061bf..a1729ce 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.1.0", - "@stdlib/array-ctors": "^0.1.0", - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/blas-base-gcopy": "^0.1.0", - "@stdlib/strided-base-reinterpret-complex128": "^0.1.0", - "@stdlib/strided-base-reinterpret-complex64": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0", - "@stdlib/types": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.1.0", - "@stdlib/array-complex64": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-float32": "^0.1.0", - "@stdlib/array-float64": "^0.1.0", - "@stdlib/array-int16": "^0.1.0", - "@stdlib/array-int32": "^0.1.0", - "@stdlib/array-int8": "^0.1.0", - "@stdlib/array-uint16": "^0.1.0", - "@stdlib/array-uint32": "^0.1.0", - "@stdlib/array-uint8": "^0.1.0", - "@stdlib/array-uint8c": "^0.1.0", - "@stdlib/assert-is-array": "^0.1.0", - "@stdlib/assert-is-complex128": "^0.1.0", - "@stdlib/assert-is-complex128array": "^0.1.0", - "@stdlib/assert-is-complex64": "^0.1.0", - "@stdlib/assert-is-complex64array": "^0.1.0", - "@stdlib/assert-is-float32array": "^0.1.0", - "@stdlib/assert-is-float64array": "^0.1.0", - "@stdlib/assert-is-int16array": "^0.1.0", - "@stdlib/assert-is-int32array": "^0.1.0", - "@stdlib/assert-is-int8array": "^0.1.0", - "@stdlib/assert-is-uint16array": "^0.1.0", - "@stdlib/assert-is-uint32array": "^0.1.0", - "@stdlib/assert-is-uint8array": "^0.1.0", - "@stdlib/assert-is-uint8clampedarray": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/complex-imag": "^0.1.0", - "@stdlib/complex-imagf": "^0.1.0", - "@stdlib/complex-real": "^0.1.0", - "@stdlib/complex-realf": "^0.1.0", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..33c38f8 --- /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 851e624..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From f8d2d0c1f7b48a5b20405125605a58c900eaaf52 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 18:28:48 +0000 Subject: [PATCH 48/96] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 63137d0..12140cb 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.1.0", "@stdlib/strided-base-reinterpret-complex128": "^0.1.0", "@stdlib/strided-base-reinterpret-complex64": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.1.0" }, "devDependencies": { From d1896bfd2c8253de9418aec1338b0d867319bea2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 21:12:35 +0000 Subject: [PATCH 49/96] Remove files --- index.d.ts | 210 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6392 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 0cc341f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,210 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c8cb6ca..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/assert-is-collection@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@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 d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O,GW",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P,Mp",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 9fe15d3..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O,GW', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P,Mp', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,WAAYV,IAG1C,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,WAAYb,IAa1C,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 33c38f8..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 332456d535841b4069243c5aabb43fc089fa194b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 21:16:34 +0000 Subject: [PATCH 50/96] 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 | 41 +- benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 506 -- test/test.js | 506 -- 45 files changed, 6202 insertions(+), 5500 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 344114b..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: '11 11 * * 5' - - # 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 + + ```
@@ -172,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -234,7 +227,7 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index c73faf0..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 33de2f7..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 03c8991..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 aed997b..0cc341f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..19cad15 --- /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/assert-is-collection@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n 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/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function a(e){return"complex128"===e}function l(l,p){var j,c,h,v,g,u,b;if(!e(l))throw new TypeError(n("invalid argument. First argument must be an array-like object. Value: `%s`.",l));if("generic"===p)return m(l);if(null===(c=r(p)))throw new TypeError(n("invalid argument. Second argument must be a recognized array data type. Value: `%s`.",p));return u=l.length,j=o(b=t(l)),g=new c(u),j||a(b)?(h=j?i(l,0):s(l,0),o(p)?(v=i(g,0),d(2*u,h,1,v,1),g):a(p)?(v=s(g,0),d(2*u,h,1,v,1),g):(d(u,h,2,g,1),g)):(j=o(p))||a(p)?(v=j?i(g,0):s(g,0),d(u,l,1,v,2),g):(d(u,l,1,g,1),g)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..0083a69 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/string-format';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;kvBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,8EAA+EV,IAG7G,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,uFAAwFb,IAatH,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 36192e5..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 12140cb..a1729ce 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.1.0", - "@stdlib/array-ctors": "^0.1.0", - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/blas-base-gcopy": "^0.1.0", - "@stdlib/strided-base-reinterpret-complex128": "^0.1.0", - "@stdlib/strided-base-reinterpret-complex64": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.1.0", - "@stdlib/array-complex64": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-float32": "^0.1.0", - "@stdlib/array-float64": "^0.1.0", - "@stdlib/array-int16": "^0.1.0", - "@stdlib/array-int32": "^0.1.0", - "@stdlib/array-int8": "^0.1.0", - "@stdlib/array-uint16": "^0.1.0", - "@stdlib/array-uint32": "^0.1.0", - "@stdlib/array-uint8": "^0.1.0", - "@stdlib/array-uint8c": "^0.1.0", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-complex128": "^0.1.0", - "@stdlib/assert-is-complex128array": "^0.1.0", - "@stdlib/assert-is-complex64": "^0.1.0", - "@stdlib/assert-is-complex64array": "^0.1.0", - "@stdlib/assert-is-float32array": "^0.1.1", - "@stdlib/assert-is-float64array": "^0.1.1", - "@stdlib/assert-is-int16array": "^0.1.1", - "@stdlib/assert-is-int32array": "^0.1.1", - "@stdlib/assert-is-int8array": "^0.1.1", - "@stdlib/assert-is-uint16array": "^0.1.1", - "@stdlib/assert-is-uint32array": "^0.1.1", - "@stdlib/assert-is-uint8array": "^0.1.1", - "@stdlib/assert-is-uint8clampedarray": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/complex-imag": "^0.1.0", - "@stdlib/complex-imagf": "^0.1.0", - "@stdlib/complex-real": "^0.1.0", - "@stdlib/complex-realf": "^0.1.0", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d59da94 --- /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 851e624..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 93aa1e5f6a0afd8e4dd634f001bc1bc5b8ad2cf0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 09:33:41 +0000 Subject: [PATCH 51/96] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 90aab0a..1d04166 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.1.0", "@stdlib/strided-base-reinterpret-complex128": "^0.1.1", "@stdlib/strided-base-reinterpret-complex64": "^0.1.1", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0" }, "devDependencies": { From fb75140c7d7e4d6f77838ddc4464f31fe33f936a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:58:17 +0000 Subject: [PATCH 52/96] Remove files --- index.d.ts | 210 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6392 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 0cc341f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,210 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 19cad15..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/assert-is-collection@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n 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/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function a(e){return"complex128"===e}function l(l,p){var j,c,h,v,g,u,b;if(!e(l))throw new TypeError(n("invalid argument. First argument must be an array-like object. Value: `%s`.",l));if("generic"===p)return m(l);if(null===(c=r(p)))throw new TypeError(n("invalid argument. Second argument must be a recognized array data type. Value: `%s`.",p));return u=l.length,j=o(b=t(l)),g=new c(u),j||a(b)?(h=j?i(l,0):s(l,0),o(p)?(v=i(g,0),d(2*u,h,1,v,1),g):a(p)?(v=s(g,0),d(2*u,h,1,v,1),g):(d(u,h,2,g,1),g)):(j=o(p))||a(p)?(v=j?i(g,0):s(g,0),d(u,l,1,v,2),g):(d(u,l,1,g,1),g)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 0083a69..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/string-format';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;kvBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,8EAA+EV,IAG7G,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,uFAAwFb,IAatH,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d59da94..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From fa7dc829df94c877fde1007759bfffc7eea22c56 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:58:41 +0000 Subject: [PATCH 53/96] 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 | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 506 -- 47 files changed, 6202 insertions(+), 5037 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 f16a975..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T06:03:59.262Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 255c769..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: '11 11 * * 5' - - # 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 + + ```
@@ -172,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -234,7 +227,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 b06c304..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 888fcd5..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 03c8991..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[esm-url]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 aed997b..0cc341f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..bd52be5 --- /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/assert-is-collection@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n 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/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function a(e){return"complex128"===e}function l(l,p){var j,c,h,v,g,u,b;if(!e(l))throw new TypeError(n("invalid argument. First argument must be an array-like object. Value: `%s`.",l));if("generic"===p)return m(l);if(null===(c=r(p)))throw new TypeError(n("invalid argument. Second argument must be a recognized array data type. Value: `%s`.",p));return u=l.length,j=o(b=t(l)),g=new c(u),j||a(b)?(h=j?i(l,0):s(l,0),o(p)?(v=i(g,0),d(2*u,h,1,v,1),g):a(p)?(v=s(g,0),d(2*u,h,1,v,1),g):(d(u,h,2,g,1),g)):(j=o(p))||a(p)?(v=j?i(g,0):s(g,0),d(u,l,1,v,2),g):(d(u,l,1,g,1),g)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..0083a69 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/string-format';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;kvBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,8EAA+EV,IAG7G,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,uFAAwFb,IAatH,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 36192e5..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 1d04166..a1729ce 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.1.0", - "@stdlib/array-ctors": "^0.1.0", - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/blas-base-gcopy": "^0.1.0", - "@stdlib/strided-base-reinterpret-complex128": "^0.1.1", - "@stdlib/strided-base-reinterpret-complex64": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.1.0", - "@stdlib/array-complex64": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-float32": "^0.1.1", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/array-int16": "^0.1.1", - "@stdlib/array-int32": "^0.1.1", - "@stdlib/array-int8": "^0.1.1", - "@stdlib/array-uint16": "^0.1.1", - "@stdlib/array-uint32": "^0.1.1", - "@stdlib/array-uint8": "^0.1.1", - "@stdlib/array-uint8c": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-complex128": "^0.1.1", - "@stdlib/assert-is-complex128array": "^0.1.0", - "@stdlib/assert-is-complex64": "^0.1.1", - "@stdlib/assert-is-complex64array": "^0.1.0", - "@stdlib/assert-is-float32array": "^0.1.1", - "@stdlib/assert-is-float64array": "^0.1.1", - "@stdlib/assert-is-int16array": "^0.1.1", - "@stdlib/assert-is-int32array": "^0.1.1", - "@stdlib/assert-is-int8array": "^0.1.1", - "@stdlib/assert-is-uint16array": "^0.1.1", - "@stdlib/assert-is-uint32array": "^0.1.1", - "@stdlib/assert-is-uint8array": "^0.1.1", - "@stdlib/assert-is-uint8clampedarray": "^0.1.1", - "@stdlib/complex-imag": "^0.1.1", - "@stdlib/complex-imagf": "^0.1.1", - "@stdlib/complex-real": "^0.1.1", - "@stdlib/complex-realf": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2360271 --- /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.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 381898342b38f4f6cef78569663d61387e898583 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 02:32:21 +0000 Subject: [PATCH 54/96] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index e87e52a..32fd91a 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.2.0", "@stdlib/strided-base-reinterpret-complex128": "^0.2.0", "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/string-format": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0", "@stdlib/types": "^0.3.1" }, "devDependencies": { From d3831f344b3b5117c1fbefa028e5e9630e771041 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:12:05 +0000 Subject: [PATCH 55/96] Remove files --- index.d.ts | 210 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6392 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 0cc341f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,210 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index bd52be5..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/assert-is-collection@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n 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/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function a(e){return"complex128"===e}function l(l,p){var j,c,h,v,g,u,b;if(!e(l))throw new TypeError(n("invalid argument. First argument must be an array-like object. Value: `%s`.",l));if("generic"===p)return m(l);if(null===(c=r(p)))throw new TypeError(n("invalid argument. Second argument must be a recognized array data type. Value: `%s`.",p));return u=l.length,j=o(b=t(l)),g=new c(u),j||a(b)?(h=j?i(l,0):s(l,0),o(p)?(v=i(g,0),d(2*u,h,1,v,1),g):a(p)?(v=s(g,0),d(2*u,h,1,v,1),g):(d(u,h,2,g,1),g)):(j=o(p))||a(p)?(v=j?i(g,0):s(g,0),d(u,l,1,v,2),g):(d(u,l,1,g,1),g)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 0083a69..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/string-format';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;kvBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,8EAA+EV,IAG7G,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,uFAAwFb,IAatH,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2360271..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 3f6eacca04a27ac024d9f6cf51113105627158fe Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:13:20 +0000 Subject: [PATCH 56/96] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 506 -- 46 files changed, 6202 insertions(+), 5045 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 dfe28bf..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: '11 11 * * 5' - - # 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 + + ```
@@ -174,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -239,7 +230,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 b06c304..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 888fcd5..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 1713fe2..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convertArray = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convertArray( arr, DTYPES[ i ] ); - console.log( out ); -} 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 aed997b..0cc341f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8330cc5 --- /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/assert-is-collection@v0.2.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n 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/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function a(e){return"complex128"===e}function l(l,p){var j,c,h,v,g,u,b;if(!e(l))throw new TypeError(n("invalid argument. First argument must be an array-like object. Value: `%s`.",l));if("generic"===p)return m(l);if(null===(c=r(p)))throw new TypeError(n("invalid argument. Second argument must be a recognized array data type. Value: `%s`.",p));return u=l.length,j=o(b=t(l)),g=new c(u),j||a(b)?(h=j?i(l,0):s(l,0),o(p)?(v=i(g,0),d(2*u,h,1,v,1),g):a(p)?(v=s(g,0),d(2*u,h,1,v,1),g):(d(u,h,2,g,1),g)):(j=o(p))||a(p)?(v=j?i(g,0):s(g,0),d(u,l,1,v,2),g):(d(u,l,1,g,1),g)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..0083a69 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/string-format';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;kvBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,8EAA+EV,IAG7G,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,uFAAwFb,IAatH,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 36192e5..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 32fd91a..64efc6d 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.0", - "@stdlib/array-ctors": "^0.2.0", - "@stdlib/array-dtype": "^0.2.0", - "@stdlib/assert-is-collection": "^0.2.0", - "@stdlib/blas-base-gcopy": "^0.2.0", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.0", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0", - "@stdlib/types": "^0.3.1" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.1.0", - "@stdlib/array-complex64": "^0.1.0", - "@stdlib/array-dtypes": "^0.2.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-float32": "^0.2.0", - "@stdlib/array-float64": "^0.2.0", - "@stdlib/array-int16": "^0.2.0", - "@stdlib/array-int32": "^0.2.0", - "@stdlib/array-int8": "^0.2.0", - "@stdlib/array-uint16": "^0.2.0", - "@stdlib/array-uint32": "^0.2.0", - "@stdlib/array-uint8": "^0.2.0", - "@stdlib/array-uint8c": "^0.2.0", - "@stdlib/assert-is-array": "^0.2.0", - "@stdlib/assert-is-complex128": "^0.2.0", - "@stdlib/assert-is-complex128array": "^0.1.0", - "@stdlib/assert-is-complex64": "^0.2.0", - "@stdlib/assert-is-complex64array": "^0.1.0", - "@stdlib/assert-is-float32array": "^0.2.0", - "@stdlib/assert-is-float64array": "^0.2.0", - "@stdlib/assert-is-int16array": "^0.2.0", - "@stdlib/assert-is-int32array": "^0.2.0", - "@stdlib/assert-is-int8array": "^0.2.0", - "@stdlib/assert-is-uint16array": "^0.2.0", - "@stdlib/assert-is-uint32array": "^0.2.0", - "@stdlib/assert-is-uint8array": "^0.2.0", - "@stdlib/assert-is-uint8clampedarray": "^0.2.0", - "@stdlib/complex-imag": "^0.2.0", - "@stdlib/complex-imagf": "^0.2.0", - "@stdlib/complex-real": "^0.2.0", - "@stdlib/complex-realf": "^0.2.0", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c38b062 --- /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.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From e8f02be8a4bfafc5d6436a34b7545e5e9fe91703 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:48:55 +0000 Subject: [PATCH 57/96] Update README.md for ESM bundle v0.2.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 44e57fb..c9a8def 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.2.0-esm/index.mjs'; ``` #### convertArray( arr, dtype ) @@ -109,7 +109,7 @@ The function supports the following data types: var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform' ).factory; import filledarrayBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled-by@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.2.0-esm/index.mjs'; // Create a generic array: var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); From cd4563ff845bc00d905876cca3467de27f8d4297 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:48:56 +0000 Subject: [PATCH 58/96] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c9a8def..9d0a2dd 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-convert/tags). For example, + ```javascript import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.2.0-esm/index.mjs'; ``` @@ -109,7 +114,7 @@ The function supports the following data types: var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform' ).factory; import filledarrayBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled-by@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.2.0-esm/index.mjs'; +import convertArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; // Create a generic array: var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); From 058f4e5420ab70aa78437512a65010f9d69414ae Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 20 Feb 2024 08:41:41 +0000 Subject: [PATCH 59/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..528a761 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 4456578..07151a3 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.2.0", "@stdlib/strided-base-reinterpret-complex128": "^0.2.0", "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/string-format": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0", "@stdlib/types": "^0.3.1" }, "devDependencies": { From db9eaa2895a2f8424f7e7033bbb5158a1ff0ad9b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 20 Feb 2024 08:42:10 +0000 Subject: [PATCH 60/96] Remove files --- index.d.ts | 210 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6392 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 0cc341f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,210 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8330cc5..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/assert-is-collection@v0.2.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n 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/blas-base-gcopy@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.1.0-esm/index.mjs";function o(e){return"complex64"===e}function a(e){return"complex128"===e}function l(l,p){var j,c,h,v,g,u,b;if(!e(l))throw new TypeError(n("invalid argument. First argument must be an array-like object. Value: `%s`.",l));if("generic"===p)return m(l);if(null===(c=r(p)))throw new TypeError(n("invalid argument. Second argument must be a recognized array data type. Value: `%s`.",p));return u=l.length,j=o(b=t(l)),g=new c(u),j||a(b)?(h=j?i(l,0):s(l,0),o(p)?(v=i(g,0),d(2*u,h,1,v,1),g):a(p)?(v=s(g,0),d(2*u,h,1,v,1),g):(d(u,h,2,g,1),g)):(j=o(p))||a(p)?(v=j?i(g,0):s(g,0),d(u,l,1,v,2),g):(d(u,l,1,g,1),g)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 0083a69..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/string-format';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;kvBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,8EAA+EV,IAG7G,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,uFAAwFb,IAatH,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c38b062..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 030827927eab8a8866cb0bed7101c0cba1b4f6d6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 20 Feb 2024 08:43:46 +0000 Subject: [PATCH 61/96] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 65 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 506 --- 46 files changed, 4867 insertions(+), 5039 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/benchmark.length.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/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -174,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -239,7 +230,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 b06c304..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 888fcd5..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 26de09a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} 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 aed997b..0cc341f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8e44def --- /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/assert-is-collection@v0.2.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.0-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8da5a09 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 528a761..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 07151a3..64efc6d 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.0", - "@stdlib/array-ctors": "^0.2.0", - "@stdlib/array-dtype": "^0.2.0", - "@stdlib/assert-is-collection": "^0.2.0", - "@stdlib/blas-base-gcopy": "^0.2.0", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.0", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0", - "@stdlib/types": "^0.3.1" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.2.0", - "@stdlib/array-complex64": "^0.2.0", - "@stdlib/array-dtypes": "^0.2.0", - "@stdlib/array-filled-by": "^0.2.0", - "@stdlib/array-float32": "^0.2.0", - "@stdlib/array-float64": "^0.2.0", - "@stdlib/array-int16": "^0.2.0", - "@stdlib/array-int32": "^0.2.0", - "@stdlib/array-int8": "^0.2.0", - "@stdlib/array-uint16": "^0.2.0", - "@stdlib/array-uint32": "^0.2.0", - "@stdlib/array-uint8": "^0.2.0", - "@stdlib/array-uint8c": "^0.2.0", - "@stdlib/assert-is-array": "^0.2.0", - "@stdlib/assert-is-complex128": "^0.2.0", - "@stdlib/assert-is-complex128array": "^0.2.0", - "@stdlib/assert-is-complex64": "^0.2.0", - "@stdlib/assert-is-complex64array": "^0.2.0", - "@stdlib/assert-is-float32array": "^0.2.0", - "@stdlib/assert-is-float64array": "^0.2.0", - "@stdlib/assert-is-int16array": "^0.2.0", - "@stdlib/assert-is-int32array": "^0.2.0", - "@stdlib/assert-is-int8array": "^0.2.0", - "@stdlib/assert-is-uint16array": "^0.2.0", - "@stdlib/assert-is-uint32array": "^0.2.0", - "@stdlib/assert-is-uint8array": "^0.2.0", - "@stdlib/assert-is-uint8clampedarray": "^0.2.0", - "@stdlib/complex-imag": "^0.2.0", - "@stdlib/complex-imagf": "^0.2.0", - "@stdlib/complex-real": "^0.2.0", - "@stdlib/complex-realf": "^0.2.0", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/random-base-discrete-uniform": "^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.0" - }, - "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..eff9ac9 --- /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.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 36f4002a814ab662c723f37ff44635fccfb49871 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 22 Feb 2024 22:03:13 +0000 Subject: [PATCH 62/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..528a761 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 708448e..995e821 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.2.0", "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2" }, "devDependencies": { From fc03bb82966633bbc367ccc9ec133939864c0c76 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 22 Feb 2024 22:46:47 +0000 Subject: [PATCH 63/96] Remove files --- index.d.ts | 210 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5057 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 0cc341f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,210 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { AnyArray, Collection, Complex128Array, Complex64Array, DataType } from '@stdlib/types/array'; - -/** -* Converts an array to a `Float64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float64' ): Float64Array; - -/** -* Converts an array to a `Float32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float32' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'float32' ): Float32Array; - -/** -* Converts an array to an `Int32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int32' ): Int32Array; - -/** -* Converts an array to an `Int16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int16' ): Int16Array; - -/** -* Converts an array to an `Int8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'int8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'int8' ): Int8Array; - -/** -* Converts an array to a `Uint32Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint32' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint32' ): Uint32Array; - -/** -* Converts an array to a `Uint16Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint16' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint16' ): Uint16Array; - -/** -* Converts an array to a `Uint8Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8' ): Uint8Array; - -/** -* Converts an array to a `Uint8ClampedArray`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'uint8c' ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function convert( x: Collection, dtype: 'uint8c' ): Uint8ClampedArray; - -/** -* Converts an array to a `Complex128Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex128' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex128' ): Complex128Array; - -/** -* Converts an array to a `Complex64Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'complex64' ); -* // returns -*/ -declare function convert( x: Collection, dtype: 'complex64' ): Complex64Array; - -/** -* Converts an array to an `Array`. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'generic' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: 'generic' ): Array; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert( x: Collection, dtype: DataType ): AnyArray; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8e44def..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/assert-is-collection@v0.2.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.0-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8da5a09..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index eff9ac9..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 886fd07ad50682f72d7602f9c0915583753f55f3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 22 Feb 2024 22:48:41 +0000 Subject: [PATCH 64/96] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 67 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 92 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 506 --- 46 files changed, 4867 insertions(+), 5041 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -174,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -239,7 +230,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 b06c304..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 888fcd5..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 98916b6..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,67 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..55f5e3d --- /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/assert-is-collection@v0.2.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.0-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8da5a09 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 528a761..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 995e821..64efc6d 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Convert an array to an array of a different data type.", "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,71 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.0", - "@stdlib/array-ctors": "^0.2.0", - "@stdlib/array-dtype": "^0.2.0", - "@stdlib/assert-is-collection": "^0.2.0", - "@stdlib/blas-base-gcopy": "^0.2.0", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.2.0", - "@stdlib/array-complex64": "^0.2.0", - "@stdlib/array-dtypes": "^0.2.0", - "@stdlib/array-filled-by": "^0.2.0", - "@stdlib/array-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-int16": "^0.2.1", - "@stdlib/array-int32": "^0.2.1", - "@stdlib/array-int8": "^0.2.1", - "@stdlib/array-uint16": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/array-uint8c": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex128": "^0.2.0", - "@stdlib/assert-is-complex128array": "^0.2.0", - "@stdlib/assert-is-complex64": "^0.2.0", - "@stdlib/assert-is-complex64array": "^0.2.0", - "@stdlib/assert-is-float32array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/assert-is-int16array": "^0.2.1", - "@stdlib/assert-is-int32array": "^0.2.1", - "@stdlib/assert-is-int8array": "^0.2.1", - "@stdlib/assert-is-uint16array": "^0.2.1", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/assert-is-uint8array": "^0.2.1", - "@stdlib/assert-is-uint8clampedarray": "^0.2.1", - "@stdlib/complex-imag": "^0.2.0", - "@stdlib/complex-imagf": "^0.2.0", - "@stdlib/complex-real": "^0.2.0", - "@stdlib/complex-realf": "^0.2.0", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/random-base-discrete-uniform": "^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.0" - }, - "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..96e300d --- /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.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 4f2f78bedd894dd11da711ca9d61772d5e77be28 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 20:50:34 +0000 Subject: [PATCH 65/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..528a761 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index df9796b..7fadb57 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.2.0", "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, From f9e4829b6b5f2ef7eca4479bf867632b373702bd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:10:21 +0000 Subject: [PATCH 66/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 55f5e3d..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/assert-is-collection@v0.2.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.0-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8da5a09..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 96e300d..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 46209735f92a2e5d2535fe2a4ad4797ed5a25f88 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:10:54 +0000 Subject: [PATCH 67/96] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 67 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 93 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 506 --- 46 files changed, 4867 insertions(+), 5042 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -174,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -239,7 +230,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 b06c304..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 888fcd5..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 98916b6..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,67 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8cebf3e --- /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/assert-is-collection@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8da5a09 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 528a761..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 7fadb57..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,72 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.1", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/array-dtype": "^0.2.1", - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/blas-base-gcopy": "^0.2.0", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.2.0", - "@stdlib/array-complex64": "^0.2.0", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.0", - "@stdlib/array-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-int16": "^0.2.1", - "@stdlib/array-int32": "^0.2.1", - "@stdlib/array-int8": "^0.2.1", - "@stdlib/array-uint16": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/array-uint8c": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex128": "^0.2.1", - "@stdlib/assert-is-complex128array": "^0.2.0", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-complex64array": "^0.2.0", - "@stdlib/assert-is-float32array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/assert-is-int16array": "^0.2.1", - "@stdlib/assert-is-int32array": "^0.2.1", - "@stdlib/assert-is-int8array": "^0.2.1", - "@stdlib/assert-is-uint16array": "^0.2.1", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/assert-is-uint8array": "^0.2.1", - "@stdlib/assert-is-uint8clampedarray": "^0.2.1", - "@stdlib/complex-imag": "^0.2.1", - "@stdlib/complex-imagf": "^0.2.1", - "@stdlib/complex-real": "^0.2.1", - "@stdlib/complex-realf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..4e27b2b --- /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.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 34984cae0ffb7f2b81de4ab4aa3c9486064d8dd2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:30:26 +0000 Subject: [PATCH 68/96] Update README.md for ESM bundle v0.2.1 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 22d1a07..f289787 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import convert from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +import convert from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.2.1-esm/index.mjs'; ``` #### convert( arr, dtype ) @@ -109,7 +109,7 @@ The function supports the following data types: var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform' ).factory; import filledarrayBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled-by@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import convert from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +import convert from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.2.1-esm/index.mjs'; // Create a generic array: var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); From dc8a98367aed11c951879616c0e83182182ef857 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:30:27 +0000 Subject: [PATCH 69/96] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f289787..ee02c56 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import convert from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-convert/tags). For example, + ```javascript import convert from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.2.1-esm/index.mjs'; ``` @@ -109,7 +114,7 @@ The function supports the following data types: var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-discrete-uniform' ).factory; import filledarrayBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled-by@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import convert from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@v0.2.1-esm/index.mjs'; +import convert from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-convert@esm/index.mjs'; // Create a generic array: var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); From 25d1a633cd17e047126ae92f0807c8e556e3c98a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 08:22:39 +0000 Subject: [PATCH 70/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..528a761 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 66bdba7..2cb4c77 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.2.1", "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, From fbe7e0930ebeb05b6718d623f83d65116a5a81a4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:56:59 +0000 Subject: [PATCH 71/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8cebf3e..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/assert-is-collection@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8da5a09..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 4e27b2b..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 57fe30b3252ef74a34169f979881150689835045 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:57:14 +0000 Subject: [PATCH 72/96] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 67 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 93 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 506 --- 47 files changed, 4867 insertions(+), 5047 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 d3247cb..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:48:21.701Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -174,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -239,7 +230,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 b06c304..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 888fcd5..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 98916b6..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,67 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7098c18 --- /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/assert-is-collection@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8da5a09 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 528a761..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 2cb4c77..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,72 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.1", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/array-dtype": "^0.2.1", - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/blas-base-gcopy": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.2.1", - "@stdlib/array-complex64": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-int16": "^0.2.1", - "@stdlib/array-int32": "^0.2.1", - "@stdlib/array-int8": "^0.2.1", - "@stdlib/array-uint16": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/array-uint8c": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex128": "^0.2.1", - "@stdlib/assert-is-complex128array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-complex64array": "^0.2.1", - "@stdlib/assert-is-float32array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/assert-is-int16array": "^0.2.1", - "@stdlib/assert-is-int32array": "^0.2.1", - "@stdlib/assert-is-int8array": "^0.2.1", - "@stdlib/assert-is-uint16array": "^0.2.1", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/assert-is-uint8array": "^0.2.1", - "@stdlib/assert-is-uint8clampedarray": "^0.2.1", - "@stdlib/complex-imag": "^0.2.1", - "@stdlib/complex-imagf": "^0.2.1", - "@stdlib/complex-real": "^0.2.1", - "@stdlib/complex-realf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..54dbacf --- /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.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 6d629affc2ba79fbcdc22c08e64fffdf2adfcc7c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 04:32:54 +0000 Subject: [PATCH 73/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 36192e5..528a761 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var getType = require( '@stdlib/array-dtype' ); var ctors = require( '@stdlib/array-ctors' ); var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); @@ -98,7 +98,7 @@ function convert( x, dtype ) { var t; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -106,7 +106,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 66bdba7..2cb4c77 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/blas-base-gcopy": "^0.2.1", "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, From 50367413bd3546993e867bbf2504be36fc47a656 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:13:15 +0000 Subject: [PATCH 74/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7098c18..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/assert-is-collection@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8da5a09..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 54dbacf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d72e93ee842f8f005b5e703ef8ff0632f056ef0b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:13:37 +0000 Subject: [PATCH 75/96] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 329 -- benchmark/benchmark.length.js | 135 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 41 - docs/types/test.ts | 67 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 163 - package.json | 93 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 506 --- 46 files changed, 4867 insertions(+), 5048 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -174,7 +165,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -239,7 +230,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 b06c304..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,329 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index 888fcd5..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,135 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index d42622b..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var b=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var p=b(function(j,q){ -var w=require('@stdlib/assert-is-collection/dist'),h=require('@stdlib/array-dtype/dist'),C=require('@stdlib/array-ctors/dist'),s=require('@stdlib/strided-base-reinterpret-complex128/dist'),l=require('@stdlib/strided-base-reinterpret-complex64/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist'),o=require('@stdlib/blas-base-gcopy/dist'),T=require('@stdlib/array-base-copy/dist');function f(r){return r==="complex64"}function m(r){return r==="complex128"}function y(r,e){var a,v,u,t,i,n,c;if(!w(r))throw new TypeError(g('00V2O',r));if(e==="generic")return T(r);if(v=C(e),v===null)throw new TypeError(g('00V2P',e));return n=r.length,c=h(r),a=f(c),i=new v(n),a||m(c)?(a?u=l(r,0):u=s(r,0),f(e)?(t=l(i,0),o(n*2,u,1,t,1),i):m(e)?(t=s(i,0),o(n*2,u,1,t,1),i):(o(n,u,2,i,1),i)):(a=f(e),a||m(e)?(a?t=l(i,0):t=s(i,0),o(n,r,1,t,2),i):(o(n,r,1,i,1),i))}q.exports=y -});var E=p();module.exports=E; -/** @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 8ff6089..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.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 isCollection = require( '@stdlib/assert-is-collection' );\nvar getType = require( '@stdlib/array-dtype' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' );\nvar reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' );\nvar format = require( '@stdlib/string-format' );\nvar gcopy = require( '@stdlib/blas-base-gcopy' );\nvar copy = require( '@stdlib/array-base-copy' );\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAS,QAAS,uBAAwB,EAC1CC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAoBA,SAASE,EAASC,EAAGH,EAAQ,CAC5B,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACnB,EAAcY,CAAE,EACrB,MAAM,IAAI,UAAWP,EAAQ,8EAA+EO,CAAE,CAAE,EAGjH,GAAKH,IAAU,UACd,OAAOF,EAAMK,CAAE,EAGhB,GADAE,EAAOZ,EAAOO,CAAM,EACfK,IAAS,KACb,MAAM,IAAI,UAAWT,EAAQ,uFAAwFI,CAAM,CAAE,EAa9H,OAVAS,EAAMN,EAAE,OAGRO,EAAIlB,EAASW,CAAE,EACfC,EAAQL,EAAaW,CAAE,EAGvBF,EAAM,IAAIH,EAAMI,CAAI,EAGfL,GAASH,EAAcS,CAAE,GACxBN,EACJE,EAAOX,EAAeQ,EAAG,CAAE,EAE3BG,EAAOZ,EAAgBS,EAAG,CAAE,EAGxBJ,EAAaC,CAAM,GACvBO,EAAOZ,EAAea,EAAK,CAAE,EAC7BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,GAEHP,EAAcD,CAAM,GACxBO,EAAOb,EAAgBc,EAAK,CAAE,EAC9BX,EAAOY,EAAI,EAAGH,EAAM,EAAGC,EAAM,CAAE,EACxBC,IAGRX,EAAOY,EAAKH,EAAM,EAAGE,EAAK,CAAE,EACrBA,KAGRJ,EAAQL,EAAaC,CAAM,EACtBI,GAASH,EAAcD,CAAM,GAC5BI,EACJG,EAAOZ,EAAea,EAAK,CAAE,EAE7BD,EAAOb,EAAgBc,EAAK,CAAE,EAG/BX,EAAOY,EAAKN,EAAG,EAAGI,EAAM,CAAE,EACnBC,IAGRX,EAAOY,EAAKN,EAAG,EAAGK,EAAK,CAAE,EAClBA,GACR,CAKAlB,EAAO,QAAUY,IC9HjB,IAAIS,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "format", "gcopy", "copy", "isComplex64", "dtype", "isComplex128", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "out", "len", "t", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 465e73a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,41 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - The function supports the following data types: - - - float32: single-precision floating-point numbers. - - float64: double-precision floating-point numbers. - - complex64: single-precision complex floating-point numbers. - - complex128: double-precision complex floating-point numbers. - - generic: values of any type. - - int16: signed 16-bit integers. - - int32: signed 32-bit integers. - - int8: signed 8-bit integers. - - uint16: unsigned 16-bit integers. - - uint32: unsigned 32-bit integers. - - uint8: unsigned 8-bit integers. - - uint8c: unsigned clamped 8-bit integers. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 98916b6..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,67 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7098c18 --- /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/assert-is-collection@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8da5a09 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 528a761..0000000 --- a/lib/main.js +++ /dev/null @@ -1,163 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var out; - var len; - var t; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 2cb4c77..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,72 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.1", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/array-dtype": "^0.2.1", - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/blas-base-gcopy": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-complex128": "^0.2.1", - "@stdlib/array-complex64": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-int16": "^0.2.1", - "@stdlib/array-int32": "^0.2.1", - "@stdlib/array-int8": "^0.2.1", - "@stdlib/array-uint16": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/array-uint8c": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-complex128": "^0.2.1", - "@stdlib/assert-is-complex128array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-complex64array": "^0.2.1", - "@stdlib/assert-is-float32array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/assert-is-int16array": "^0.2.1", - "@stdlib/assert-is-int32array": "^0.2.1", - "@stdlib/assert-is-int8array": "^0.2.1", - "@stdlib/assert-is-uint16array": "^0.2.1", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/assert-is-uint8array": "^0.2.1", - "@stdlib/assert-is-uint8clampedarray": "^0.2.1", - "@stdlib/complex-imag": "^0.2.1", - "@stdlib/complex-imagf": "^0.2.1", - "@stdlib/complex-real": "^0.2.1", - "@stdlib/complex-realf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..54dbacf --- /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.js b/test/test.js deleted file mode 100644 index 2050243..0000000 --- a/test/test.js +++ /dev/null @@ -1,506 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From fb21f7e4021515c5d1acd83e8d1e10123d230174 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jul 2024 22:08:27 +0000 Subject: [PATCH 76/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 79e2b36..128a695 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // FUNCTIONS // @@ -121,7 +121,7 @@ function convert( x, dtype ) { var i; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -129,7 +129,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 8976b88..d7a3b1d 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.1", "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, From 96c9dd5a289e4f31fe8a7b17f9fbd2dabae9c1c2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jul 2024 22:08:53 +0000 Subject: [PATCH 77/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7098c18..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/assert-is-collection@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";function o(e){return"complex64"===e}function p(e){return"complex128"===e}function l(l,j){var c,h,v,f,a,b,x;if(!e(l))throw new TypeError(n("00V2O",l));if("generic"===j)return m(l);if(null===(h=r(j)))throw new TypeError(n("00V2P",j));return b=l.length,c=o(x=t(l)),a=new h(b),c||p(x)?(v=c?i(l,0):s(l,0),o(j)?(f=i(a,0),d(2*b,v,1,f,1),a):p(j)?(f=s(a,0),d(2*b,v,1,f,1),a):(d(b,v,2,a,1),a)):(c=o(j))||p(j)?(f=c?i(a,0):s(a,0),d(b,l,1,f,2),a):(d(b,l,1,a,1),a)}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8da5a09..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.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 isCollection from '@stdlib/assert-is-collection';\nimport getType from '@stdlib/array-dtype';\nimport ctors from '@stdlib/array-ctors';\nimport reinterpret128 from '@stdlib/strided-base-reinterpret-complex128';\nimport reinterpret64 from '@stdlib/strided-base-reinterpret-complex64';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport gcopy from '@stdlib/blas-base-gcopy';\nimport copy from '@stdlib/array-base-copy';\n\n\n// FUNCTIONS //\n\n/**\n* Tests whether a data type is a single-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex64( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex64( 'complex64' );\n* // returns true\n*/\nfunction isComplex64( dtype ) {\n\treturn ( dtype === 'complex64' );\n}\n\n/**\n* Tests whether a data type is a double-precision complex floating-point number data type.\n*\n* @private\n* @param {string} dtype - data type\n* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type\n*\n* @example\n* var bool = isComplex128( 'float64' );\n* // returns false\n*\n* @example\n* var bool = isComplex128( 'complex128' );\n* // returns true\n*/\nfunction isComplex128( dtype ) {\n\treturn ( dtype === 'complex128' );\n}\n\n\n// MAIN //\n\n/**\n* Converts an array to an array of a different data type.\n*\n* @param {Collection} x - array to convert\n* @param {string} dtype - output data type\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a recognized array data type\n* @returns {(Array|TypedArray|ComplexArray)} output array\n*\n* @example\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar out;\n\tvar len;\n\tvar t;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","convert","x","isc64","ctor","xbuf","obuf","out","len","t","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy"],"mappings":";;2vBAiDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAoBA,SAASE,EAASC,EAAGH,GACpB,IAAII,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcR,GACnB,MAAM,IAAIS,UAAWC,EAAQ,QAASV,IAGvC,GAAe,YAAVH,EACJ,OAAOc,EAAMX,GAGd,GAAc,QADdE,EAAOU,EAAOf,IAEb,MAAM,IAAIY,UAAWC,EAAQ,QAASb,IAavC,OAVAS,EAAMN,EAAEa,OAIRZ,EAAQL,EADRW,EAAIO,EAASd,IAIbK,EAAM,IAAIH,EAAMI,GAGXL,GAASH,EAAcS,IAE1BJ,EADIF,EACGc,EAAef,EAAG,GAElBgB,EAAgBhB,EAAG,GAGtBJ,EAAaC,IACjBO,EAAOW,EAAeV,EAAK,GAC3BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,GAEHP,EAAcD,IAClBO,EAAOY,EAAgBX,EAAK,GAC5BY,EAAW,EAAJX,EAAOH,EAAM,EAAGC,EAAM,GACtBC,IAGRY,EAAOX,EAAKH,EAAM,EAAGE,EAAK,GACnBA,KAGRJ,EAAQL,EAAaC,KACPC,EAAcD,IAE1BO,EADIH,EACGc,EAAeV,EAAK,GAEpBW,EAAgBX,EAAK,GAG7BY,EAAOX,EAAKN,EAAG,EAAGI,EAAM,GACjBC,IAGRY,EAAOX,EAAKN,EAAG,EAAGK,EAAK,GAChBA,EACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 54dbacf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e6f5bbe0d50dc9b0289e7a796bcad5e57157b534 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jul 2024 22:09:53 +0000 Subject: [PATCH 78/96] 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 | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 121 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 354 -- benchmark/benchmark.length.js | 138 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 6 - dist/index.js.map | 7 - docs/repl.txt | 26 - docs/types/test.ts | 68 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 236 - package.json | 97 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 712 --- 46 files changed, 4868 insertions(+), 5474 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 f92a6c5..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 + + ```
@@ -159,7 +150,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -222,11 +213,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-convert/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/esm -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 effe96a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,354 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=bool', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'bool' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index fd518bf..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,138 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'bool' ); - bench( pkg+':len='+len+',dtype=bool', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 78e3d80..0000000 --- a/dist/index.js +++ /dev/null @@ -1,6 +0,0 @@ -"use strict";var T=function(e,n){return function(){return n||e((n={exports:{}}).exports,n),n.exports}};var C=T(function(S,h){ -var B=require('@stdlib/assert-is-collection/dist'),E=require('@stdlib/array-dtype/dist'),V=require('@stdlib/array-ctors/dist'),l=require('@stdlib/strided-base-reinterpret-complex128/dist'),s=require('@stdlib/strided-base-reinterpret-complex64/dist'),c=require('@stdlib/strided-base-reinterpret-boolean/dist'),o=require('@stdlib/blas-base-gcopy/dist'),j=require('@stdlib/array-base-copy/dist'),k=require('@stdlib/array-base-resolve-getter/dist'),p=require('@stdlib/error-tools-fmtprodmsg/dist');function m(e){return e==="complex64"}function q(e){return e==="complex128"}function g(e){return e==="bool"}function z(e,n){var f,b,a,i,w,r,t,v,u;if(!B(e))throw new TypeError(p('00V2O',e));if(n==="generic")return j(e);if(b=V(n),b===null)throw new TypeError(p('00V2P',n));if(t=e.length,v=E(e),f=m(v),r=new b(t),f||q(v)){if(f?a=s(e,0):a=l(e,0),m(n))return i=s(r,0),o(t*2,a,1,i,1),r;if(q(n))return i=l(r,0),o(t*2,a,1,i,1),r;if(g(n)){for(i=c(r,0),u=0;u[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAS,QAAS,uBAAwB,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAiBA,SAASE,EAAQF,EAAQ,CACxB,OAASA,IAAU,MACpB,CAoBA,SAASG,EAASC,EAAGJ,EAAQ,CAC5B,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACxB,EAAce,CAAE,EACrB,MAAM,IAAI,UAAWN,EAAQ,8EAA+EM,CAAE,CAAE,EAGjH,GAAKJ,IAAU,UACd,OAAOJ,EAAMQ,CAAE,EAGhB,GADAE,EAAOf,EAAOS,CAAM,EACfM,IAAS,KACb,MAAM,IAAI,UAAWR,EAAQ,uFAAwFE,CAAM,CAAE,EAa9H,GAVAW,EAAMP,EAAE,OAGRQ,EAAItB,EAASc,CAAE,EACfC,EAAQN,EAAaa,CAAE,EAGvBF,EAAM,IAAIJ,EAAMK,CAAI,EAGfN,GAASJ,EAAcW,CAAE,EAAI,CAOjC,GANKP,EACJE,EAAOd,EAAeW,EAAG,CAAE,EAE3BG,EAAOf,EAAgBY,EAAG,CAAE,EAGxBL,EAAaC,CAAM,EACvB,OAAAQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAER,GAAKT,EAAcD,CAAM,EACxB,OAAAQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAEtB,IADAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAC5BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,CAAE,GAAKN,EAAO,EAAEM,EAAG,CAAE,EACjCL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,CACR,CAEA,GAAKR,EAAQU,CAAE,EAId,OAHAL,EAAOb,EAAoBU,EAAG,CAAE,EAG3BF,EAAQF,CAAM,GAClBQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAGHX,EAAaC,CAAM,GACvBQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAEHT,EAAcD,CAAM,GACxBQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,IAERf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,GAIR,GADAL,EAAQN,EAAaC,CAAM,EACtBK,GAASJ,EAAcD,CAAM,EACjC,OAAKK,EACJG,EAAOf,EAAeiB,EAAK,CAAE,EAE7BF,EAAOhB,EAAgBkB,EAAK,CAAE,EAG/Bf,EAAOgB,EAAKP,EAAG,EAAGI,EAAM,CAAE,EACnBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAGtB,IAFAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCD,EAAMZ,EAAeO,CAAE,EACjBS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,CAAE,EACdL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKP,EAAG,EAAGM,EAAK,CAAE,EAClBA,CACR,CAKAtB,EAAO,QAAUe,ICvMjB,IAAIW,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "reinterpretBoolean", "gcopy", "copy", "resolveGetter", "format", "isComplex64", "dtype", "isComplex128", "isBool", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "get", "out", "len", "t", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a822c0c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,26 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 6306c6c..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'bool' ); // $ExpectType BooleanArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a63b926 --- /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/assert-is-collection@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 128a695..0000000 --- a/lib/main.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); -var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - -/** -* Tests whether a data type is a boolean data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a boolean data type -* -* @example -* var bool = isBool( 'bool' ); -* // returns true -* -* @example -* var bool = isBool( 'complex128' ); -* // returns false -*/ -function isBool( dtype ) { - return ( dtype === 'bool' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var get; - var out; - var len; - var t; - var i; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // cmplx => bool - obuf = reinterpretBoolean( out, 0 ); - for ( i = 0; i < len; i++ ) { - // A complex number is only falsy when both the real and imaginary components are zero... - if ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether the input array is a boolean array... - if ( isBool( t ) ) { - xbuf = reinterpretBoolean( x, 0 ); - - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // bool => bool - obuf = reinterpretBoolean( out, 0 ); - gcopy( len, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // bool => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - if ( isComplex128( dtype ) ) { // bool => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - gcopy( len, xbuf, 1, out, 1 ); // bool => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { - obuf = reinterpretBoolean( out, 0 ); - get = resolveGetter( x ); - for ( i = 0; i < len; i++ ) { - if ( get( x, i ) ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index d7a3b1d..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,76 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.1", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/array-dtype": "^0.2.1", - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/blas-base-gcopy": "^0.2.1", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.1", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-bool": "^0.0.1", - "@stdlib/array-complex128": "^0.2.1", - "@stdlib/array-complex64": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-int16": "^0.2.1", - "@stdlib/array-int32": "^0.2.1", - "@stdlib/array-int8": "^0.2.1", - "@stdlib/array-uint16": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/array-uint8c": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-booleanarray": "^0.0.1", - "@stdlib/assert-is-complex128": "^0.2.1", - "@stdlib/assert-is-complex128array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-complex64array": "^0.2.1", - "@stdlib/assert-is-float32array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/assert-is-int16array": "^0.2.1", - "@stdlib/assert-is-int32array": "^0.2.1", - "@stdlib/assert-is-int8array": "^0.2.1", - "@stdlib/assert-is-uint16array": "^0.2.1", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/assert-is-uint8array": "^0.2.1", - "@stdlib/assert-is-uint8clampedarray": "^0.2.1", - "@stdlib/complex-imag": "^0.2.1", - "@stdlib/complex-imagf": "^0.2.1", - "@stdlib/complex-real": "^0.2.1", - "@stdlib/complex-realf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..cbaaf90 --- /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.js b/test/test.js deleted file mode 100644 index 7c94640..0000000 --- a/test/test.js +++ /dev/null @@ -1,712 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isBooleanArray = require( '@stdlib/assert-is-booleanarray' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var real = require( '@stdlib/complex-real' ); -var imag = require( '@stdlib/complex-imag' ); -var realf = require( '@stdlib/complex-realf' ); -var imagf = require( '@stdlib/complex-imagf' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (generic => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ 'foo', null, [], {} ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ -1, 0, 1, 2 ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = new Uint8Array( [ 1, 0, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (bool => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - [ new Complex64Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new BooleanArray( [ true, false, true ] ); - expected = [ - [ new Float64Array( [ 1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ 1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ new Int16Array( [ 1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ 1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ 1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 1, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 1, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 1, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 1, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => generic)', function test( t ) { - var expected; - var arr; - var out; - var i; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - t.strictEqual( out[ i ], expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => bool)', function test( t ) { - var expected; - var out; - var arr; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.deepEqual( out.length, expected.length, 'returns expected value' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128', - 'bool' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array, - isBooleanArray - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 08e1fbf8c38c08884ae1b45c5efe8b4f8477e498 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 10:18:32 +0000 Subject: [PATCH 79/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 79e2b36..128a695 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // FUNCTIONS // @@ -121,7 +121,7 @@ function convert( x, dtype ) { var i; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -129,7 +129,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 0d80b16..de2b1f6 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.1", "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, From 62e50e20efc0a077a143c5160af789c2d43a94c1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 10:23:58 +0000 Subject: [PATCH 80/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a63b926..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/assert-is-collection@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index cbaaf90..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 1e4bc012c83d1e0ccfea09598b1f8907b3138745 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 10:24:16 +0000 Subject: [PATCH 81/96] 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 | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 125 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 354 -- benchmark/benchmark.length.js | 138 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 6 - dist/index.js.map | 7 - docs/repl.txt | 26 - docs/types/test.ts | 68 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 236 - package.json | 97 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 712 --- 46 files changed, 4868 insertions(+), 5478 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 f92a6c5..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 + + ```
@@ -159,7 +150,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -222,11 +213,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-convert/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/esm -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 effe96a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,354 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=bool', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'bool' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index fd518bf..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,138 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'bool' ); - bench( pkg+':len='+len+',dtype=bool', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 78e3d80..0000000 --- a/dist/index.js +++ /dev/null @@ -1,6 +0,0 @@ -"use strict";var T=function(e,n){return function(){return n||e((n={exports:{}}).exports,n),n.exports}};var C=T(function(S,h){ -var B=require('@stdlib/assert-is-collection/dist'),E=require('@stdlib/array-dtype/dist'),V=require('@stdlib/array-ctors/dist'),l=require('@stdlib/strided-base-reinterpret-complex128/dist'),s=require('@stdlib/strided-base-reinterpret-complex64/dist'),c=require('@stdlib/strided-base-reinterpret-boolean/dist'),o=require('@stdlib/blas-base-gcopy/dist'),j=require('@stdlib/array-base-copy/dist'),k=require('@stdlib/array-base-resolve-getter/dist'),p=require('@stdlib/error-tools-fmtprodmsg/dist');function m(e){return e==="complex64"}function q(e){return e==="complex128"}function g(e){return e==="bool"}function z(e,n){var f,b,a,i,w,r,t,v,u;if(!B(e))throw new TypeError(p('00V2O',e));if(n==="generic")return j(e);if(b=V(n),b===null)throw new TypeError(p('00V2P',n));if(t=e.length,v=E(e),f=m(v),r=new b(t),f||q(v)){if(f?a=s(e,0):a=l(e,0),m(n))return i=s(r,0),o(t*2,a,1,i,1),r;if(q(n))return i=l(r,0),o(t*2,a,1,i,1),r;if(g(n)){for(i=c(r,0),u=0;u[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAS,QAAS,uBAAwB,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAiBA,SAASE,EAAQF,EAAQ,CACxB,OAASA,IAAU,MACpB,CAoBA,SAASG,EAASC,EAAGJ,EAAQ,CAC5B,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACxB,EAAce,CAAE,EACrB,MAAM,IAAI,UAAWN,EAAQ,8EAA+EM,CAAE,CAAE,EAGjH,GAAKJ,IAAU,UACd,OAAOJ,EAAMQ,CAAE,EAGhB,GADAE,EAAOf,EAAOS,CAAM,EACfM,IAAS,KACb,MAAM,IAAI,UAAWR,EAAQ,uFAAwFE,CAAM,CAAE,EAa9H,GAVAW,EAAMP,EAAE,OAGRQ,EAAItB,EAASc,CAAE,EACfC,EAAQN,EAAaa,CAAE,EAGvBF,EAAM,IAAIJ,EAAMK,CAAI,EAGfN,GAASJ,EAAcW,CAAE,EAAI,CAOjC,GANKP,EACJE,EAAOd,EAAeW,EAAG,CAAE,EAE3BG,EAAOf,EAAgBY,EAAG,CAAE,EAGxBL,EAAaC,CAAM,EACvB,OAAAQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAER,GAAKT,EAAcD,CAAM,EACxB,OAAAQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAEtB,IADAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAC5BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,CAAE,GAAKN,EAAO,EAAEM,EAAG,CAAE,EACjCL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,CACR,CAEA,GAAKR,EAAQU,CAAE,EAId,OAHAL,EAAOb,EAAoBU,EAAG,CAAE,EAG3BF,EAAQF,CAAM,GAClBQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAGHX,EAAaC,CAAM,GACvBQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAEHT,EAAcD,CAAM,GACxBQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,IAERf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,GAIR,GADAL,EAAQN,EAAaC,CAAM,EACtBK,GAASJ,EAAcD,CAAM,EACjC,OAAKK,EACJG,EAAOf,EAAeiB,EAAK,CAAE,EAE7BF,EAAOhB,EAAgBkB,EAAK,CAAE,EAG/Bf,EAAOgB,EAAKP,EAAG,EAAGI,EAAM,CAAE,EACnBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAGtB,IAFAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCD,EAAMZ,EAAeO,CAAE,EACjBS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,CAAE,EACdL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKP,EAAG,EAAGM,EAAK,CAAE,EAClBA,CACR,CAKAtB,EAAO,QAAUe,ICvMjB,IAAIW,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "reinterpretBoolean", "gcopy", "copy", "resolveGetter", "format", "isComplex64", "dtype", "isComplex128", "isBool", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "get", "out", "len", "t", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a822c0c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,26 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 6306c6c..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'bool' ); // $ExpectType BooleanArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a63b926 --- /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/assert-is-collection@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 128a695..0000000 --- a/lib/main.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); -var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - -/** -* Tests whether a data type is a boolean data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a boolean data type -* -* @example -* var bool = isBool( 'bool' ); -* // returns true -* -* @example -* var bool = isBool( 'complex128' ); -* // returns false -*/ -function isBool( dtype ) { - return ( dtype === 'bool' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var get; - var out; - var len; - var t; - var i; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // cmplx => bool - obuf = reinterpretBoolean( out, 0 ); - for ( i = 0; i < len; i++ ) { - // A complex number is only falsy when both the real and imaginary components are zero... - if ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether the input array is a boolean array... - if ( isBool( t ) ) { - xbuf = reinterpretBoolean( x, 0 ); - - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // bool => bool - obuf = reinterpretBoolean( out, 0 ); - gcopy( len, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // bool => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - if ( isComplex128( dtype ) ) { // bool => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - gcopy( len, xbuf, 1, out, 1 ); // bool => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { - obuf = reinterpretBoolean( out, 0 ); - get = resolveGetter( x ); - for ( i = 0; i < len; i++ ) { - if ( get( x, i ) ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index de2b1f6..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,76 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.1", - "@stdlib/array-base-resolve-getter": "^0.2.1", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/array-dtype": "^0.2.1", - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/blas-base-gcopy": "^0.2.1", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.1", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.1", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-bool": "^0.0.1", - "@stdlib/array-complex128": "^0.2.1", - "@stdlib/array-complex64": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-int16": "^0.2.1", - "@stdlib/array-int32": "^0.2.1", - "@stdlib/array-int8": "^0.2.1", - "@stdlib/array-uint16": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/array-uint8c": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-booleanarray": "^0.0.1", - "@stdlib/assert-is-complex128": "^0.2.1", - "@stdlib/assert-is-complex128array": "^0.2.1", - "@stdlib/assert-is-complex64": "^0.2.1", - "@stdlib/assert-is-complex64array": "^0.2.1", - "@stdlib/assert-is-float32array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/assert-is-int16array": "^0.2.1", - "@stdlib/assert-is-int32array": "^0.2.1", - "@stdlib/assert-is-int8array": "^0.2.1", - "@stdlib/assert-is-uint16array": "^0.2.1", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/assert-is-uint8array": "^0.2.1", - "@stdlib/assert-is-uint8clampedarray": "^0.2.1", - "@stdlib/complex-float32-imag": "github:stdlib-js/complex-float32-imag#main", - "@stdlib/complex-float32-real": "github:stdlib-js/complex-float32-real#main", - "@stdlib/complex-float64-imag": "github:stdlib-js/complex-float64-imag#main", - "@stdlib/complex-float64-real": "github:stdlib-js/complex-float64-real#main", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..cbaaf90 --- /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.js b/test/test.js deleted file mode 100644 index cb88546..0000000 --- a/test/test.js +++ /dev/null @@ -1,712 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isBooleanArray = require( '@stdlib/assert-is-booleanarray' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (generic => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ 'foo', null, [], {} ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ -1, 0, 1, 2 ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = new Uint8Array( [ 1, 0, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (bool => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - [ new Complex64Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new BooleanArray( [ true, false, true ] ); - expected = [ - [ new Float64Array( [ 1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ 1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ new Int16Array( [ 1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ 1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ 1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 1, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 1, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 1, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 1, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => generic)', function test( t ) { - var expected; - var arr; - var out; - var i; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - t.strictEqual( out[ i ], expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => bool)', function test( t ) { - var expected; - var out; - var arr; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.deepEqual( out.length, expected.length, 'returns expected value' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128', - 'bool' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array, - isBooleanArray - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From b2bf202c1849d07b2a63bf9a7ab5624c1d0adb9d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 03:51:37 +0000 Subject: [PATCH 82/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 79e2b36..128a695 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // FUNCTIONS // @@ -121,7 +121,7 @@ function convert( x, dtype ) { var i; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -129,7 +129,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 9a1a8cc..2284d5a 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From 7af026f6060e4dd22ef5f52f1f28ff78f032d187 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 05:05:05 +0000 Subject: [PATCH 83/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a63b926..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/assert-is-collection@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.1-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index cbaaf90..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From cd08d567e9b132b53c122f31d396f9077f95440f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 05:05:29 +0000 Subject: [PATCH 84/96] 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 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 237 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 354 -- benchmark/benchmark.length.js | 138 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 6 - dist/index.js.map | 7 - docs/repl.txt | 26 - docs/types/test.ts | 68 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 236 - package.json | 97 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 712 --- 48 files changed, 4868 insertions(+), 5698 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0779e8a..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 = 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 39b4caf..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-30T03:17:21.708Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -159,7 +150,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -222,11 +213,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-convert/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/esm -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 effe96a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,354 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=bool', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'bool' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index fd518bf..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,138 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'bool' ); - bench( pkg+':len='+len+',dtype=bool', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 78e3d80..0000000 --- a/dist/index.js +++ /dev/null @@ -1,6 +0,0 @@ -"use strict";var T=function(e,n){return function(){return n||e((n={exports:{}}).exports,n),n.exports}};var C=T(function(S,h){ -var B=require('@stdlib/assert-is-collection/dist'),E=require('@stdlib/array-dtype/dist'),V=require('@stdlib/array-ctors/dist'),l=require('@stdlib/strided-base-reinterpret-complex128/dist'),s=require('@stdlib/strided-base-reinterpret-complex64/dist'),c=require('@stdlib/strided-base-reinterpret-boolean/dist'),o=require('@stdlib/blas-base-gcopy/dist'),j=require('@stdlib/array-base-copy/dist'),k=require('@stdlib/array-base-resolve-getter/dist'),p=require('@stdlib/error-tools-fmtprodmsg/dist');function m(e){return e==="complex64"}function q(e){return e==="complex128"}function g(e){return e==="bool"}function z(e,n){var f,b,a,i,w,r,t,v,u;if(!B(e))throw new TypeError(p('00V2O',e));if(n==="generic")return j(e);if(b=V(n),b===null)throw new TypeError(p('00V2P',n));if(t=e.length,v=E(e),f=m(v),r=new b(t),f||q(v)){if(f?a=s(e,0):a=l(e,0),m(n))return i=s(r,0),o(t*2,a,1,i,1),r;if(q(n))return i=l(r,0),o(t*2,a,1,i,1),r;if(g(n)){for(i=c(r,0),u=0;u[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAS,QAAS,uBAAwB,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAiBA,SAASE,EAAQF,EAAQ,CACxB,OAASA,IAAU,MACpB,CAoBA,SAASG,EAASC,EAAGJ,EAAQ,CAC5B,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACxB,EAAce,CAAE,EACrB,MAAM,IAAI,UAAWN,EAAQ,8EAA+EM,CAAE,CAAE,EAGjH,GAAKJ,IAAU,UACd,OAAOJ,EAAMQ,CAAE,EAGhB,GADAE,EAAOf,EAAOS,CAAM,EACfM,IAAS,KACb,MAAM,IAAI,UAAWR,EAAQ,uFAAwFE,CAAM,CAAE,EAa9H,GAVAW,EAAMP,EAAE,OAGRQ,EAAItB,EAASc,CAAE,EACfC,EAAQN,EAAaa,CAAE,EAGvBF,EAAM,IAAIJ,EAAMK,CAAI,EAGfN,GAASJ,EAAcW,CAAE,EAAI,CAOjC,GANKP,EACJE,EAAOd,EAAeW,EAAG,CAAE,EAE3BG,EAAOf,EAAgBY,EAAG,CAAE,EAGxBL,EAAaC,CAAM,EACvB,OAAAQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAER,GAAKT,EAAcD,CAAM,EACxB,OAAAQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAEtB,IADAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAC5BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,CAAE,GAAKN,EAAO,EAAEM,EAAG,CAAE,EACjCL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,CACR,CAEA,GAAKR,EAAQU,CAAE,EAId,OAHAL,EAAOb,EAAoBU,EAAG,CAAE,EAG3BF,EAAQF,CAAM,GAClBQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAGHX,EAAaC,CAAM,GACvBQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAEHT,EAAcD,CAAM,GACxBQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,IAERf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,GAIR,GADAL,EAAQN,EAAaC,CAAM,EACtBK,GAASJ,EAAcD,CAAM,EACjC,OAAKK,EACJG,EAAOf,EAAeiB,EAAK,CAAE,EAE7BF,EAAOhB,EAAgBkB,EAAK,CAAE,EAG/Bf,EAAOgB,EAAKP,EAAG,EAAGI,EAAM,CAAE,EACnBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAGtB,IAFAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCD,EAAMZ,EAAeO,CAAE,EACjBS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,CAAE,EACdL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKP,EAAG,EAAGM,EAAK,CAAE,EAClBA,CACR,CAKAtB,EAAO,QAAUe,ICvMjB,IAAIW,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "reinterpretBoolean", "gcopy", "copy", "resolveGetter", "format", "isComplex64", "dtype", "isComplex128", "isBool", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "get", "out", "len", "t", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a822c0c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,26 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 6306c6c..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'bool' ); // $ExpectType BooleanArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..93c5bac --- /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/assert-is-collection@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 128a695..0000000 --- a/lib/main.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); -var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - -/** -* Tests whether a data type is a boolean data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a boolean data type -* -* @example -* var bool = isBool( 'bool' ); -* // returns true -* -* @example -* var bool = isBool( 'complex128' ); -* // returns false -*/ -function isBool( dtype ) { - return ( dtype === 'bool' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var get; - var out; - var len; - var t; - var i; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // cmplx => bool - obuf = reinterpretBoolean( out, 0 ); - for ( i = 0; i < len; i++ ) { - // A complex number is only falsy when both the real and imaginary components are zero... - if ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether the input array is a boolean array... - if ( isBool( t ) ) { - xbuf = reinterpretBoolean( x, 0 ); - - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // bool => bool - obuf = reinterpretBoolean( out, 0 ); - gcopy( len, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // bool => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - if ( isComplex128( dtype ) ) { // bool => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - gcopy( len, xbuf, 1, out, 1 ); // bool => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { - obuf = reinterpretBoolean( out, 0 ); - get = resolveGetter( x ); - for ( i = 0; i < len; i++ ) { - if ( get( x, i ) ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 2284d5a..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,76 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/blas-base-gcopy": "^0.2.1", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-int16": "^0.2.2", - "@stdlib/array-int32": "^0.2.2", - "@stdlib/array-int8": "^0.2.2", - "@stdlib/array-uint16": "^0.2.2", - "@stdlib/array-uint32": "^0.2.2", - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/array-uint8c": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-booleanarray": "^0.0.2", - "@stdlib/assert-is-complex128": "^0.2.2", - "@stdlib/assert-is-complex128array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-complex64array": "^0.2.2", - "@stdlib/assert-is-float32array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/assert-is-int16array": "^0.2.2", - "@stdlib/assert-is-int32array": "^0.2.2", - "@stdlib/assert-is-int8array": "^0.2.2", - "@stdlib/assert-is-uint16array": "^0.2.2", - "@stdlib/assert-is-uint32array": "^0.2.2", - "@stdlib/assert-is-uint8array": "^0.2.2", - "@stdlib/assert-is-uint8clampedarray": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/complex-float64-imag": "^0.1.1", - "@stdlib/complex-float64-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-discrete-uniform": "^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..205e697 --- /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.js b/test/test.js deleted file mode 100644 index cb88546..0000000 --- a/test/test.js +++ /dev/null @@ -1,712 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isBooleanArray = require( '@stdlib/assert-is-booleanarray' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (generic => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ 'foo', null, [], {} ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ -1, 0, 1, 2 ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = new Uint8Array( [ 1, 0, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (bool => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - [ new Complex64Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new BooleanArray( [ true, false, true ] ); - expected = [ - [ new Float64Array( [ 1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ 1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ new Int16Array( [ 1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ 1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ 1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 1, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 1, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 1, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 1, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => generic)', function test( t ) { - var expected; - var arr; - var out; - var i; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - t.strictEqual( out[ i ], expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => bool)', function test( t ) { - var expected; - var out; - var arr; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.deepEqual( out.length, expected.length, 'returns expected value' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128', - 'bool' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array, - isBooleanArray - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 12898321facfe0d0481bfe73ecc343edd570ee09 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 6 Jan 2025 01:45:41 +0000 Subject: [PATCH 85/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 79e2b36..128a695 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // FUNCTIONS // @@ -121,7 +121,7 @@ function convert( x, dtype ) { var i; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -129,7 +129,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 9a1a8cc..2284d5a 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From 24f41ecaaa930a615039f287147a060570902ed7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 6 Jan 2025 01:50:39 +0000 Subject: [PATCH 86/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 93c5bac..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/assert-is-collection@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 205e697..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ab6744589115fb993b8db3eb09eb677452fe6417 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 6 Jan 2025 01:51:01 +0000 Subject: [PATCH 87/96] 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 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 237 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 354 -- benchmark/benchmark.length.js | 138 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 6 - dist/index.js.map | 7 - docs/repl.txt | 26 - docs/types/test.ts | 68 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 236 - package.json | 97 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 712 --- 48 files changed, 4868 insertions(+), 5698 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0779e8a..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 = 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 7327cf4..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-01-06T01:44:55.030Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c114b5c..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -159,7 +150,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -222,11 +213,11 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-convert/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/esm -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 effe96a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,354 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=bool', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'bool' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index fd518bf..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,138 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'bool' ); - bench( pkg+':len='+len+',dtype=bool', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 78e3d80..0000000 --- a/dist/index.js +++ /dev/null @@ -1,6 +0,0 @@ -"use strict";var T=function(e,n){return function(){return n||e((n={exports:{}}).exports,n),n.exports}};var C=T(function(S,h){ -var B=require('@stdlib/assert-is-collection/dist'),E=require('@stdlib/array-dtype/dist'),V=require('@stdlib/array-ctors/dist'),l=require('@stdlib/strided-base-reinterpret-complex128/dist'),s=require('@stdlib/strided-base-reinterpret-complex64/dist'),c=require('@stdlib/strided-base-reinterpret-boolean/dist'),o=require('@stdlib/blas-base-gcopy/dist'),j=require('@stdlib/array-base-copy/dist'),k=require('@stdlib/array-base-resolve-getter/dist'),p=require('@stdlib/error-tools-fmtprodmsg/dist');function m(e){return e==="complex64"}function q(e){return e==="complex128"}function g(e){return e==="bool"}function z(e,n){var f,b,a,i,w,r,t,v,u;if(!B(e))throw new TypeError(p('00V2O',e));if(n==="generic")return j(e);if(b=V(n),b===null)throw new TypeError(p('00V2P',n));if(t=e.length,v=E(e),f=m(v),r=new b(t),f||q(v)){if(f?a=s(e,0):a=l(e,0),m(n))return i=s(r,0),o(t*2,a,1,i,1),r;if(q(n))return i=l(r,0),o(t*2,a,1,i,1),r;if(g(n)){for(i=c(r,0),u=0;u[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAS,QAAS,uBAAwB,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAiBA,SAASE,EAAQF,EAAQ,CACxB,OAASA,IAAU,MACpB,CAoBA,SAASG,EAASC,EAAGJ,EAAQ,CAC5B,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACxB,EAAce,CAAE,EACrB,MAAM,IAAI,UAAWN,EAAQ,8EAA+EM,CAAE,CAAE,EAGjH,GAAKJ,IAAU,UACd,OAAOJ,EAAMQ,CAAE,EAGhB,GADAE,EAAOf,EAAOS,CAAM,EACfM,IAAS,KACb,MAAM,IAAI,UAAWR,EAAQ,uFAAwFE,CAAM,CAAE,EAa9H,GAVAW,EAAMP,EAAE,OAGRQ,EAAItB,EAASc,CAAE,EACfC,EAAQN,EAAaa,CAAE,EAGvBF,EAAM,IAAIJ,EAAMK,CAAI,EAGfN,GAASJ,EAAcW,CAAE,EAAI,CAOjC,GANKP,EACJE,EAAOd,EAAeW,EAAG,CAAE,EAE3BG,EAAOf,EAAgBY,EAAG,CAAE,EAGxBL,EAAaC,CAAM,EACvB,OAAAQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAER,GAAKT,EAAcD,CAAM,EACxB,OAAAQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAEtB,IADAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAC5BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,CAAE,GAAKN,EAAO,EAAEM,EAAG,CAAE,EACjCL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,CACR,CAEA,GAAKR,EAAQU,CAAE,EAId,OAHAL,EAAOb,EAAoBU,EAAG,CAAE,EAG3BF,EAAQF,CAAM,GAClBQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAGHX,EAAaC,CAAM,GACvBQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAEHT,EAAcD,CAAM,GACxBQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,IAERf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,GAIR,GADAL,EAAQN,EAAaC,CAAM,EACtBK,GAASJ,EAAcD,CAAM,EACjC,OAAKK,EACJG,EAAOf,EAAeiB,EAAK,CAAE,EAE7BF,EAAOhB,EAAgBkB,EAAK,CAAE,EAG/Bf,EAAOgB,EAAKP,EAAG,EAAGI,EAAM,CAAE,EACnBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAGtB,IAFAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCD,EAAMZ,EAAeO,CAAE,EACjBS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,CAAE,EACdL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKP,EAAG,EAAGM,EAAK,CAAE,EAClBA,CACR,CAKAtB,EAAO,QAAUe,ICvMjB,IAAIW,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "reinterpretBoolean", "gcopy", "copy", "resolveGetter", "format", "isComplex64", "dtype", "isComplex128", "isBool", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "get", "out", "len", "t", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a822c0c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,26 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 6306c6c..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'bool' ); // $ExpectType BooleanArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0abb169 --- /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/assert-is-collection@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 128a695..0000000 --- a/lib/main.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); -var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - -/** -* Tests whether a data type is a boolean data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a boolean data type -* -* @example -* var bool = isBool( 'bool' ); -* // returns true -* -* @example -* var bool = isBool( 'complex128' ); -* // returns false -*/ -function isBool( dtype ) { - return ( dtype === 'bool' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var get; - var out; - var len; - var t; - var i; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // cmplx => bool - obuf = reinterpretBoolean( out, 0 ); - for ( i = 0; i < len; i++ ) { - // A complex number is only falsy when both the real and imaginary components are zero... - if ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether the input array is a boolean array... - if ( isBool( t ) ) { - xbuf = reinterpretBoolean( x, 0 ); - - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // bool => bool - obuf = reinterpretBoolean( out, 0 ); - gcopy( len, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // bool => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - if ( isComplex128( dtype ) ) { // bool => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - gcopy( len, xbuf, 1, out, 1 ); // bool => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { - obuf = reinterpretBoolean( out, 0 ); - get = resolveGetter( x ); - for ( i = 0; i < len; i++ ) { - if ( get( x, i ) ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 2284d5a..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,76 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/blas-base-gcopy": "^0.2.1", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-int16": "^0.2.2", - "@stdlib/array-int32": "^0.2.2", - "@stdlib/array-int8": "^0.2.2", - "@stdlib/array-uint16": "^0.2.2", - "@stdlib/array-uint32": "^0.2.2", - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/array-uint8c": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-booleanarray": "^0.0.2", - "@stdlib/assert-is-complex128": "^0.2.2", - "@stdlib/assert-is-complex128array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-complex64array": "^0.2.2", - "@stdlib/assert-is-float32array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/assert-is-int16array": "^0.2.2", - "@stdlib/assert-is-int32array": "^0.2.2", - "@stdlib/assert-is-int8array": "^0.2.2", - "@stdlib/assert-is-uint16array": "^0.2.2", - "@stdlib/assert-is-uint32array": "^0.2.2", - "@stdlib/assert-is-uint8array": "^0.2.2", - "@stdlib/assert-is-uint8clampedarray": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/complex-float64-imag": "^0.1.1", - "@stdlib/complex-float64-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-discrete-uniform": "^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..205e697 --- /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.js b/test/test.js deleted file mode 100644 index cb88546..0000000 --- a/test/test.js +++ /dev/null @@ -1,712 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isBooleanArray = require( '@stdlib/assert-is-booleanarray' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (generic => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ 'foo', null, [], {} ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ -1, 0, 1, 2 ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = new Uint8Array( [ 1, 0, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (bool => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - [ new Complex64Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new BooleanArray( [ true, false, true ] ); - expected = [ - [ new Float64Array( [ 1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ 1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ new Int16Array( [ 1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ 1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ 1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 1, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 1, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 1, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 1, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => generic)', function test( t ) { - var expected; - var arr; - var out; - var i; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - t.strictEqual( out[ i ], expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => bool)', function test( t ) { - var expected; - var out; - var arr; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.deepEqual( out.length, expected.length, 'returns expected value' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128', - 'bool' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array, - isBooleanArray - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From 81140d7f8a38941b8dda212917e7427896c9795f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Feb 2025 01:16:48 +0000 Subject: [PATCH 88/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 79e2b36..128a695 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // FUNCTIONS // @@ -121,7 +121,7 @@ function convert( x, dtype ) { var i; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -129,7 +129,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 9a1a8cc..2284d5a 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From 591e673b311acca0cb1410e0fbefdb0fc9e48a92 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Feb 2025 01:42:49 +0000 Subject: [PATCH 89/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0abb169..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/assert-is-collection@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 205e697..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 471712c06c8cbf8f8ae0e6e3be0ac9dcc1ec54eb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Feb 2025 01:43:10 +0000 Subject: [PATCH 90/96] 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 | 237 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 354 -- benchmark/benchmark.length.js | 138 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 6 - dist/index.js.map | 7 - docs/repl.txt | 26 - docs/types/test.ts | 68 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 236 - package.json | 97 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 712 --- 48 files changed, 4868 insertions(+), 5701 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 0bf5712..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-02-24T01:08:54.682Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 19cd8fb..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -159,7 +150,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -222,11 +213,11 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-convert/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/esm -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 effe96a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,354 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=bool', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'bool' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index fd518bf..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,138 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'bool' ); - bench( pkg+':len='+len+',dtype=bool', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 78e3d80..0000000 --- a/dist/index.js +++ /dev/null @@ -1,6 +0,0 @@ -"use strict";var T=function(e,n){return function(){return n||e((n={exports:{}}).exports,n),n.exports}};var C=T(function(S,h){ -var B=require('@stdlib/assert-is-collection/dist'),E=require('@stdlib/array-dtype/dist'),V=require('@stdlib/array-ctors/dist'),l=require('@stdlib/strided-base-reinterpret-complex128/dist'),s=require('@stdlib/strided-base-reinterpret-complex64/dist'),c=require('@stdlib/strided-base-reinterpret-boolean/dist'),o=require('@stdlib/blas-base-gcopy/dist'),j=require('@stdlib/array-base-copy/dist'),k=require('@stdlib/array-base-resolve-getter/dist'),p=require('@stdlib/error-tools-fmtprodmsg/dist');function m(e){return e==="complex64"}function q(e){return e==="complex128"}function g(e){return e==="bool"}function z(e,n){var f,b,a,i,w,r,t,v,u;if(!B(e))throw new TypeError(p('00V2O',e));if(n==="generic")return j(e);if(b=V(n),b===null)throw new TypeError(p('00V2P',n));if(t=e.length,v=E(e),f=m(v),r=new b(t),f||q(v)){if(f?a=s(e,0):a=l(e,0),m(n))return i=s(r,0),o(t*2,a,1,i,1),r;if(q(n))return i=l(r,0),o(t*2,a,1,i,1),r;if(g(n)){for(i=c(r,0),u=0;u[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAS,QAAS,uBAAwB,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAiBA,SAASE,EAAQF,EAAQ,CACxB,OAASA,IAAU,MACpB,CAoBA,SAASG,EAASC,EAAGJ,EAAQ,CAC5B,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACxB,EAAce,CAAE,EACrB,MAAM,IAAI,UAAWN,EAAQ,8EAA+EM,CAAE,CAAE,EAGjH,GAAKJ,IAAU,UACd,OAAOJ,EAAMQ,CAAE,EAGhB,GADAE,EAAOf,EAAOS,CAAM,EACfM,IAAS,KACb,MAAM,IAAI,UAAWR,EAAQ,uFAAwFE,CAAM,CAAE,EAa9H,GAVAW,EAAMP,EAAE,OAGRQ,EAAItB,EAASc,CAAE,EACfC,EAAQN,EAAaa,CAAE,EAGvBF,EAAM,IAAIJ,EAAMK,CAAI,EAGfN,GAASJ,EAAcW,CAAE,EAAI,CAOjC,GANKP,EACJE,EAAOd,EAAeW,EAAG,CAAE,EAE3BG,EAAOf,EAAgBY,EAAG,CAAE,EAGxBL,EAAaC,CAAM,EACvB,OAAAQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAER,GAAKT,EAAcD,CAAM,EACxB,OAAAQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAEtB,IADAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAC5BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,CAAE,GAAKN,EAAO,EAAEM,EAAG,CAAE,EACjCL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,CACR,CAEA,GAAKR,EAAQU,CAAE,EAId,OAHAL,EAAOb,EAAoBU,EAAG,CAAE,EAG3BF,EAAQF,CAAM,GAClBQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAGHX,EAAaC,CAAM,GACvBQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAEHT,EAAcD,CAAM,GACxBQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,IAERf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,GAIR,GADAL,EAAQN,EAAaC,CAAM,EACtBK,GAASJ,EAAcD,CAAM,EACjC,OAAKK,EACJG,EAAOf,EAAeiB,EAAK,CAAE,EAE7BF,EAAOhB,EAAgBkB,EAAK,CAAE,EAG/Bf,EAAOgB,EAAKP,EAAG,EAAGI,EAAM,CAAE,EACnBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAGtB,IAFAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCD,EAAMZ,EAAeO,CAAE,EACjBS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,CAAE,EACdL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKP,EAAG,EAAGM,EAAK,CAAE,EAClBA,CACR,CAKAtB,EAAO,QAAUe,ICvMjB,IAAIW,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "reinterpretBoolean", "gcopy", "copy", "resolveGetter", "format", "isComplex64", "dtype", "isComplex128", "isBool", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "get", "out", "len", "t", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a822c0c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,26 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 6306c6c..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'bool' ); // $ExpectType BooleanArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0abb169 --- /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/assert-is-collection@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 128a695..0000000 --- a/lib/main.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); -var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - -/** -* Tests whether a data type is a boolean data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a boolean data type -* -* @example -* var bool = isBool( 'bool' ); -* // returns true -* -* @example -* var bool = isBool( 'complex128' ); -* // returns false -*/ -function isBool( dtype ) { - return ( dtype === 'bool' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var get; - var out; - var len; - var t; - var i; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // cmplx => bool - obuf = reinterpretBoolean( out, 0 ); - for ( i = 0; i < len; i++ ) { - // A complex number is only falsy when both the real and imaginary components are zero... - if ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether the input array is a boolean array... - if ( isBool( t ) ) { - xbuf = reinterpretBoolean( x, 0 ); - - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // bool => bool - obuf = reinterpretBoolean( out, 0 ); - gcopy( len, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // bool => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - if ( isComplex128( dtype ) ) { // bool => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - gcopy( len, xbuf, 1, out, 1 ); // bool => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { - obuf = reinterpretBoolean( out, 0 ); - get = resolveGetter( x ); - for ( i = 0; i < len; i++ ) { - if ( get( x, i ) ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 2284d5a..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,76 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/blas-base-gcopy": "^0.2.1", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-int16": "^0.2.2", - "@stdlib/array-int32": "^0.2.2", - "@stdlib/array-int8": "^0.2.2", - "@stdlib/array-uint16": "^0.2.2", - "@stdlib/array-uint32": "^0.2.2", - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/array-uint8c": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-booleanarray": "^0.0.2", - "@stdlib/assert-is-complex128": "^0.2.2", - "@stdlib/assert-is-complex128array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-complex64array": "^0.2.2", - "@stdlib/assert-is-float32array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/assert-is-int16array": "^0.2.2", - "@stdlib/assert-is-int32array": "^0.2.2", - "@stdlib/assert-is-int8array": "^0.2.2", - "@stdlib/assert-is-uint16array": "^0.2.2", - "@stdlib/assert-is-uint32array": "^0.2.2", - "@stdlib/assert-is-uint8array": "^0.2.2", - "@stdlib/assert-is-uint8clampedarray": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/complex-float64-imag": "^0.1.1", - "@stdlib/complex-float64-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-discrete-uniform": "^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..205e697 --- /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.js b/test/test.js deleted file mode 100644 index cb88546..0000000 --- a/test/test.js +++ /dev/null @@ -1,712 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isBooleanArray = require( '@stdlib/assert-is-booleanarray' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (generic => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ 'foo', null, [], {} ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ -1, 0, 1, 2 ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = new Uint8Array( [ 1, 0, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (bool => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - [ new Complex64Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new BooleanArray( [ true, false, true ] ); - expected = [ - [ new Float64Array( [ 1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ 1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ new Int16Array( [ 1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ 1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ 1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 1, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 1, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 1, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 1, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => generic)', function test( t ) { - var expected; - var arr; - var out; - var i; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - t.strictEqual( out[ i ], expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => bool)', function test( t ) { - var expected; - var out; - var arr; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.deepEqual( out.length, expected.length, 'returns expected value' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128', - 'bool' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array, - isBooleanArray - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From fd9c051183ae9bf1fe547f6d8ce029710c69e570 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 17 Mar 2025 01:23:50 +0000 Subject: [PATCH 91/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 79e2b36..128a695 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // FUNCTIONS // @@ -121,7 +121,7 @@ function convert( x, dtype ) { var i; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -129,7 +129,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 9a1a8cc..2284d5a 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From aef489a53240bbf4a81ef3936e006dab366bbb80 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 17 Mar 2025 01:34:42 +0000 Subject: [PATCH 92/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0abb169..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/assert-is-collection@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 205e697..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 91368700770a4ed2b489ebbec8cca11895e1b3e7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 17 Mar 2025 01:35:10 +0000 Subject: [PATCH 93/96] 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 | 237 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 354 -- benchmark/benchmark.length.js | 138 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 6 - dist/index.js.map | 7 - docs/repl.txt | 26 - docs/types/test.ts | 68 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 236 - package.json | 97 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 712 --- 48 files changed, 4868 insertions(+), 5701 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 2b3ad28..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-17T01:14:24.553Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 19cd8fb..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -159,7 +150,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -222,11 +213,11 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-convert/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/esm -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 effe96a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,354 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=bool', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'bool' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index fd518bf..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,138 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'bool' ); - bench( pkg+':len='+len+',dtype=bool', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 78e3d80..0000000 --- a/dist/index.js +++ /dev/null @@ -1,6 +0,0 @@ -"use strict";var T=function(e,n){return function(){return n||e((n={exports:{}}).exports,n),n.exports}};var C=T(function(S,h){ -var B=require('@stdlib/assert-is-collection/dist'),E=require('@stdlib/array-dtype/dist'),V=require('@stdlib/array-ctors/dist'),l=require('@stdlib/strided-base-reinterpret-complex128/dist'),s=require('@stdlib/strided-base-reinterpret-complex64/dist'),c=require('@stdlib/strided-base-reinterpret-boolean/dist'),o=require('@stdlib/blas-base-gcopy/dist'),j=require('@stdlib/array-base-copy/dist'),k=require('@stdlib/array-base-resolve-getter/dist'),p=require('@stdlib/error-tools-fmtprodmsg/dist');function m(e){return e==="complex64"}function q(e){return e==="complex128"}function g(e){return e==="bool"}function z(e,n){var f,b,a,i,w,r,t,v,u;if(!B(e))throw new TypeError(p('00V2O',e));if(n==="generic")return j(e);if(b=V(n),b===null)throw new TypeError(p('00V2P',n));if(t=e.length,v=E(e),f=m(v),r=new b(t),f||q(v)){if(f?a=s(e,0):a=l(e,0),m(n))return i=s(r,0),o(t*2,a,1,i,1),r;if(q(n))return i=l(r,0),o(t*2,a,1,i,1),r;if(g(n)){for(i=c(r,0),u=0;u[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAS,QAAS,uBAAwB,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAiBA,SAASE,EAAQF,EAAQ,CACxB,OAASA,IAAU,MACpB,CAoBA,SAASG,EAASC,EAAGJ,EAAQ,CAC5B,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACxB,EAAce,CAAE,EACrB,MAAM,IAAI,UAAWN,EAAQ,8EAA+EM,CAAE,CAAE,EAGjH,GAAKJ,IAAU,UACd,OAAOJ,EAAMQ,CAAE,EAGhB,GADAE,EAAOf,EAAOS,CAAM,EACfM,IAAS,KACb,MAAM,IAAI,UAAWR,EAAQ,uFAAwFE,CAAM,CAAE,EAa9H,GAVAW,EAAMP,EAAE,OAGRQ,EAAItB,EAASc,CAAE,EACfC,EAAQN,EAAaa,CAAE,EAGvBF,EAAM,IAAIJ,EAAMK,CAAI,EAGfN,GAASJ,EAAcW,CAAE,EAAI,CAOjC,GANKP,EACJE,EAAOd,EAAeW,EAAG,CAAE,EAE3BG,EAAOf,EAAgBY,EAAG,CAAE,EAGxBL,EAAaC,CAAM,EACvB,OAAAQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAER,GAAKT,EAAcD,CAAM,EACxB,OAAAQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAEtB,IADAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAC5BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,CAAE,GAAKN,EAAO,EAAEM,EAAG,CAAE,EACjCL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,CACR,CAEA,GAAKR,EAAQU,CAAE,EAId,OAHAL,EAAOb,EAAoBU,EAAG,CAAE,EAG3BF,EAAQF,CAAM,GAClBQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAGHX,EAAaC,CAAM,GACvBQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAEHT,EAAcD,CAAM,GACxBQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,IAERf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,GAIR,GADAL,EAAQN,EAAaC,CAAM,EACtBK,GAASJ,EAAcD,CAAM,EACjC,OAAKK,EACJG,EAAOf,EAAeiB,EAAK,CAAE,EAE7BF,EAAOhB,EAAgBkB,EAAK,CAAE,EAG/Bf,EAAOgB,EAAKP,EAAG,EAAGI,EAAM,CAAE,EACnBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAGtB,IAFAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCD,EAAMZ,EAAeO,CAAE,EACjBS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,CAAE,EACdL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKP,EAAG,EAAGM,EAAK,CAAE,EAClBA,CACR,CAKAtB,EAAO,QAAUe,ICvMjB,IAAIW,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "reinterpretBoolean", "gcopy", "copy", "resolveGetter", "format", "isComplex64", "dtype", "isComplex128", "isBool", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "get", "out", "len", "t", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a822c0c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,26 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 6306c6c..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'bool' ); // $ExpectType BooleanArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0abb169 --- /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/assert-is-collection@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 128a695..0000000 --- a/lib/main.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); -var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - -/** -* Tests whether a data type is a boolean data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a boolean data type -* -* @example -* var bool = isBool( 'bool' ); -* // returns true -* -* @example -* var bool = isBool( 'complex128' ); -* // returns false -*/ -function isBool( dtype ) { - return ( dtype === 'bool' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var get; - var out; - var len; - var t; - var i; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // cmplx => bool - obuf = reinterpretBoolean( out, 0 ); - for ( i = 0; i < len; i++ ) { - // A complex number is only falsy when both the real and imaginary components are zero... - if ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether the input array is a boolean array... - if ( isBool( t ) ) { - xbuf = reinterpretBoolean( x, 0 ); - - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // bool => bool - obuf = reinterpretBoolean( out, 0 ); - gcopy( len, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // bool => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - if ( isComplex128( dtype ) ) { // bool => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - gcopy( len, xbuf, 1, out, 1 ); // bool => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { - obuf = reinterpretBoolean( out, 0 ); - get = resolveGetter( x ); - for ( i = 0; i < len; i++ ) { - if ( get( x, i ) ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 2284d5a..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,76 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/blas-base-gcopy": "^0.2.1", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-int16": "^0.2.2", - "@stdlib/array-int32": "^0.2.2", - "@stdlib/array-int8": "^0.2.2", - "@stdlib/array-uint16": "^0.2.2", - "@stdlib/array-uint32": "^0.2.2", - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/array-uint8c": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-booleanarray": "^0.0.2", - "@stdlib/assert-is-complex128": "^0.2.2", - "@stdlib/assert-is-complex128array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-complex64array": "^0.2.2", - "@stdlib/assert-is-float32array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/assert-is-int16array": "^0.2.2", - "@stdlib/assert-is-int32array": "^0.2.2", - "@stdlib/assert-is-int8array": "^0.2.2", - "@stdlib/assert-is-uint16array": "^0.2.2", - "@stdlib/assert-is-uint32array": "^0.2.2", - "@stdlib/assert-is-uint8array": "^0.2.2", - "@stdlib/assert-is-uint8clampedarray": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/complex-float64-imag": "^0.1.1", - "@stdlib/complex-float64-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-discrete-uniform": "^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..205e697 --- /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.js b/test/test.js deleted file mode 100644 index cb88546..0000000 --- a/test/test.js +++ /dev/null @@ -1,712 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isBooleanArray = require( '@stdlib/assert-is-booleanarray' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (generic => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ 'foo', null, [], {} ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ -1, 0, 1, 2 ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = new Uint8Array( [ 1, 0, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (bool => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - [ new Complex64Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new BooleanArray( [ true, false, true ] ); - expected = [ - [ new Float64Array( [ 1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ 1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ new Int16Array( [ 1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ 1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ 1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 1, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 1, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 1, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 1, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => generic)', function test( t ) { - var expected; - var arr; - var out; - var i; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - t.strictEqual( out[ i ], expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => bool)', function test( t ) { - var expected; - var out; - var arr; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.deepEqual( out.length, expected.length, 'returns expected value' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128', - 'bool' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array, - isBooleanArray - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -}); From f4d879752d382fb4969fa08bdcddc92a309f788b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Mar 2025 00:56:25 +0000 Subject: [PATCH 94/96] Transform error messages --- lib/main.js | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 79e2b36..128a695 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); var gcopy = require( '@stdlib/blas-base-gcopy' ); var copy = require( '@stdlib/array-base-copy' ); var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // FUNCTIONS // @@ -121,7 +121,7 @@ function convert( x, dtype ) { var i; if ( !isCollection( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) ); + throw new TypeError( format( '00V2O', x ) ); } // If the output data type is "generic", our task is relatively straightforward... if ( dtype === 'generic' ) { @@ -129,7 +129,7 @@ function convert( x, dtype ) { } ctor = ctors( dtype ); if ( ctor === null ) { - throw new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '00V2P', dtype ) ); } // Cache the input array length: len = x.length; diff --git a/package.json b/package.json index 9a1a8cc..2284d5a 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From 162e53d35d17327f6616f12ddd7e4a630319b024 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Mar 2025 01:14:55 +0000 Subject: [PATCH 95/96] Remove files --- index.d.ts | 42 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4889 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 687e7cd..0000000 --- a/index.d.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, DataTypeMap } from '@stdlib/types/array'; - -/** -* Converts an array to an array of a different data type. -* -* @param x - array to convert -* @param dtype - output data type -* @returns output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -declare function convert>( x: Collection, dtype: U ): DataTypeMap[U]; - - -// EXPORTS // - -export = convert; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0abb169..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/assert-is-collection@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 205e697..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9817dc77363b2779ae174d65ab1ed2828c8d7c27 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Mar 2025 01:15:17 +0000 Subject: [PATCH 96/96] 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 | 237 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 354 -- benchmark/benchmark.length.js | 138 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 195 - benchmark/python/numpy/benchmark.py | 136 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 6 - dist/index.js.map | 7 - docs/repl.txt | 26 - docs/types/test.ts | 68 - examples/index.js | 38 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 42 - lib/main.js | 236 - package.json | 97 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 712 --- 48 files changed, 4868 insertions(+), 5701 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/benchmark.length.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 (93%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.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 e6a310f..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-24T00:48:02.995Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 19cd8fb..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/array/convert) 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 fe0680a..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/array/convert) 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 df5c712..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: '11 11 * * 5' - - # 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 + + ```
@@ -159,7 +150,7 @@ for ( i = 0; i < DTYPES.length; 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]. @@ -222,11 +213,11 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-convert/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/esm -[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same +[@stdlib/array/convert-same]: https://github.com/stdlib-js/array-convert-same/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 effe96a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,354 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'generic' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'float32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=bool', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'bool' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex128', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex128' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=complex64', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'complex64' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'int8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint32' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint16' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var out; - var i; - - arr = []; - for ( i = 0; i < 10; i++ ) { - arr.push( i ); - } - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr[ 0 ] += 1; - out = convertArray( arr, 'uint8c' ); - if ( out.length !== arr.length ) { - b.fail( 'should have expected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index fd518bf..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,138 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 pow = require( '@stdlib/math-base-special-pow' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var pkg = require( './../package.json' ).name; -var convertArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @param {string} dtype - data type -* @returns {Function} benchmark function -*/ -function createBenchmark( len, dtype ) { - var arr; - var i; - - arr = []; - for ( i = 0; i < len; i++ ) { - arr.push( i ); - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = convertArray( arr, dtype ); - if ( out.length !== len ) { - b.fail( 'unexpected length' ); - } - } - b.toc(); - if ( !isCollection( out ) ) { - b.fail( 'should return an array-like object' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len, 'generic' ); - bench( pkg+':len='+len+',dtype=generic', f ); - - f = createBenchmark( len, 'float64' ); - bench( pkg+':len='+len+',dtype=float64', f ); - - f = createBenchmark( len, 'float32' ); - bench( pkg+':len='+len+',dtype=float32', f ); - - f = createBenchmark( len, 'bool' ); - bench( pkg+':len='+len+',dtype=bool', f ); - - f = createBenchmark( len, 'complex128' ); - bench( pkg+':len='+len+',dtype=complex128', f ); - - f = createBenchmark( len, 'complex64' ); - bench( pkg+':len='+len+',dtype=complex64', f ); - - f = createBenchmark( len, 'int32' ); - bench( pkg+':len='+len+',dtype=int32', f ); - - f = createBenchmark( len, 'int16' ); - bench( pkg+':len='+len+',dtype=int16', f ); - - f = createBenchmark( len, 'int8' ); - bench( pkg+':len='+len+',dtype=int8', f ); - - f = createBenchmark( len, 'uint32' ); - bench( pkg+':len='+len+',dtype=uint32', f ); - - f = createBenchmark( len, 'uint16' ); - bench( pkg+':len='+len+',dtype=uint16', f ); - - f = createBenchmark( len, 'uint8' ); - bench( pkg+':len='+len+',dtype=uint8', f ); - - f = createBenchmark( len, 'uint8c' ); - bench( pkg+':len='+len+',dtype=uint8c', f ); - } -} - -main(); 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 ee2aa56..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,195 +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: -repeats = 3; -samples = 1e3; -count = 0; - -""" - 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( setup, expr ) - -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. - -# Arguments - -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> out = benchmark( :(), :( sin( 3.14 ) ) ); -``` -""" -function benchmark( setup, expr ) - t = eval( :( BenchmarkTools.@benchmark $expr samples=$samples setup=($setup) ) ) - - # 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 - -""" - bench( name, setup, expr ) - -Run a named benchmark. - -# Arguments - -* `name`: benchmark name (suffix) -* `setup`: setup expression -* `expr`: expression to benchmark - -# Examples - -``` julia -julia> bench( "sin", :(), :( sin( 3.14 ) ) ); -``` -""" -function bench( name, setup, expr ) - for i in 1:repeats - @printf( "# julia::%s\n", name ); - global count += 1; - results = benchmark( setup, expr ); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", count ); - end -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - - dtypes = [ - Float64, - Float32, - Int32, - Int16, - Int8, - UInt32, - UInt16, - UInt8, - ComplexF64, - ComplexF32 - ]; - n = 1; - while n < 1e7 - n *= 10; - for i in 1:length( dtypes ) - name = string( "convert:len=", n, ",dtype=", lowercase( string( dtypes[i] ) ) ); - setup = :(A = ones( Float64, $n, 1 )); - stmt = :( B = convert( Array{ $dtypes[$i] }, A ) ); - bench( name, setup, stmt ); - end - end - - print_summary( count, count ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 6660853..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,136 +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.ndarray.astype.""" - -from __future__ import print_function, division -import timeit - -NAME = "convert" -REPEATS = 3 -ITERATIONS = 1000000 -COUNT = [0] # use a list to allow modification within nested scopes - - -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(iterations, elapsed): - """Print benchmark results. - - # Arguments - - * `iterations`: number of iterations - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(100000, 0.131009101868) - ``` - """ - rate = iterations / elapsed - - print(" ---") - print(" iterations: " + str(iterations)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(name, setup, stmt, iterations): - """Run the benchmark and print benchmark results. - - # Arguments - - * `name`: benchmark name (suffix) - * `setup`: benchmark setup - * `stmt`: statement to benchmark - * `iterations`: number of iterations - - # Examples - - ``` python - python> benchmark("::random", "from random import random;", "y = random()", 1000000) - ``` - """ - t = timeit.Timer(stmt, setup=setup) - - i = 0 - while i < REPEATS: - print("# python::numpy::" + NAME + name) - COUNT[0] += 1 - elapsed = t.timeit(number=iterations) - print_results(iterations, elapsed) - print("ok " + str(COUNT[0]) + " benchmark finished") - i += 1 - - -def main(): - """Run the benchmarks.""" - print_version() - - dtypes = [ - "float64", - "float32", - "int32", - "int16", - "int8", - "uint32", - "uint16", - "uint8", - "complex64", - "complex128" - ] - iters = ITERATIONS - n = 1 - while n < 1e7: - n *= 10 - for i in range(0, len(dtypes)): - dtype = dtypes[i] - name = ":len="+str(n)+",dtype="+dtype - setup = "import numpy as np;" - setup += "A = np.ones([1,"+str(n)+"], dtype='float64');" - stmt = "B = A.astype('"+dtype+"')" - benchmark(name, setup, stmt, iters) - iters //= 4 - - print_summary(COUNT[0], COUNT[0]) - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 62355f9..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/array/convert" -%% click B href "https://github.com/stdlib-js/array-convert/tree/main" -%% click C href "https://github.com/stdlib-js/array-convert/tree/production" -%% click D href "https://github.com/stdlib-js/array-convert/tree/esm" -%% click E href "https://github.com/stdlib-js/array-convert/tree/deno" -%% click F href "https://github.com/stdlib-js/array-convert/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert -[production-url]: https://github.com/stdlib-js/array-convert/tree/production -[deno-url]: https://github.com/stdlib-js/array-convert/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-convert/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-convert/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-convert/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-convert/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-convert/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 6974d2e..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import convert from '../docs/types/index'; -export = convert; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 78e3d80..0000000 --- a/dist/index.js +++ /dev/null @@ -1,6 +0,0 @@ -"use strict";var T=function(e,n){return function(){return n||e((n={exports:{}}).exports,n),n.exports}};var C=T(function(S,h){ -var B=require('@stdlib/assert-is-collection/dist'),E=require('@stdlib/array-dtype/dist'),V=require('@stdlib/array-ctors/dist'),l=require('@stdlib/strided-base-reinterpret-complex128/dist'),s=require('@stdlib/strided-base-reinterpret-complex64/dist'),c=require('@stdlib/strided-base-reinterpret-boolean/dist'),o=require('@stdlib/blas-base-gcopy/dist'),j=require('@stdlib/array-base-copy/dist'),k=require('@stdlib/array-base-resolve-getter/dist'),p=require('@stdlib/error-tools-fmtprodmsg/dist');function m(e){return e==="complex64"}function q(e){return e==="complex128"}function g(e){return e==="bool"}function z(e,n){var f,b,a,i,w,r,t,v,u;if(!B(e))throw new TypeError(p('00V2O',e));if(n==="generic")return j(e);if(b=V(n),b===null)throw new TypeError(p('00V2P',n));if(t=e.length,v=E(e),f=m(v),r=new b(t),f||q(v)){if(f?a=s(e,0):a=l(e,0),m(n))return i=s(r,0),o(t*2,a,1,i,1),r;if(q(n))return i=l(r,0),o(t*2,a,1,i,1),r;if(g(n)){for(i=c(r,0),u=0;u[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a recognized array data type. Value: `%s`.', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = convert;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 an array to an array of a different data type.\n*\n* @module @stdlib/array-convert\n*\n* @example\n* var convert = require( '@stdlib/array-convert' );\n*\n* var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n*\n* var out = convert( arr, 'float64' );\n* // returns [ 1.0, 2.0, 3.0, 4.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAU,QAAS,qBAAsB,EACzCC,EAAQ,QAAS,qBAAsB,EACvCC,EAAiB,QAAS,6CAA8C,EACxEC,EAAgB,QAAS,4CAA6C,EACtEC,EAAqB,QAAS,0CAA2C,EACzEC,EAAQ,QAAS,yBAA0B,EAC3CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAgB,QAAS,mCAAoC,EAC7DC,EAAS,QAAS,uBAAwB,EAoB9C,SAASC,EAAaC,EAAQ,CAC7B,OAASA,IAAU,WACpB,CAiBA,SAASC,EAAcD,EAAQ,CAC9B,OAASA,IAAU,YACpB,CAiBA,SAASE,EAAQF,EAAQ,CACxB,OAASA,IAAU,MACpB,CAoBA,SAASG,EAASC,EAAGJ,EAAQ,CAC5B,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACxB,EAAce,CAAE,EACrB,MAAM,IAAI,UAAWN,EAAQ,8EAA+EM,CAAE,CAAE,EAGjH,GAAKJ,IAAU,UACd,OAAOJ,EAAMQ,CAAE,EAGhB,GADAE,EAAOf,EAAOS,CAAM,EACfM,IAAS,KACb,MAAM,IAAI,UAAWR,EAAQ,uFAAwFE,CAAM,CAAE,EAa9H,GAVAW,EAAMP,EAAE,OAGRQ,EAAItB,EAASc,CAAE,EACfC,EAAQN,EAAaa,CAAE,EAGvBF,EAAM,IAAIJ,EAAMK,CAAI,EAGfN,GAASJ,EAAcW,CAAE,EAAI,CAOjC,GANKP,EACJE,EAAOd,EAAeW,EAAG,CAAE,EAE3BG,EAAOf,EAAgBY,EAAG,CAAE,EAGxBL,EAAaC,CAAM,EACvB,OAAAQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAER,GAAKT,EAAcD,CAAM,EACxB,OAAAQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAI,EAAGJ,EAAM,EAAGC,EAAM,CAAE,EACxBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAEtB,IADAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAC5BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,CAAE,GAAKN,EAAO,EAAEM,EAAG,CAAE,EACjCL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,CACR,CAEA,GAAKR,EAAQU,CAAE,EAId,OAHAL,EAAOb,EAAoBU,EAAG,CAAE,EAG3BF,EAAQF,CAAM,GAClBQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAGHX,EAAaC,CAAM,GACvBQ,EAAOf,EAAeiB,EAAK,CAAE,EAC7Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,GAEHT,EAAcD,CAAM,GACxBQ,EAAOhB,EAAgBkB,EAAK,CAAE,EAC9Bf,EAAOgB,EAAKJ,EAAM,EAAGC,EAAM,CAAE,EACtBE,IAERf,EAAOgB,EAAKJ,EAAM,EAAGG,EAAK,CAAE,EACrBA,GAIR,GADAL,EAAQN,EAAaC,CAAM,EACtBK,GAASJ,EAAcD,CAAM,EACjC,OAAKK,EACJG,EAAOf,EAAeiB,EAAK,CAAE,EAE7BF,EAAOhB,EAAgBkB,EAAK,CAAE,EAG/Bf,EAAOgB,EAAKP,EAAG,EAAGI,EAAM,CAAE,EACnBE,EAGR,GAAKR,EAAQF,CAAM,EAAI,CAGtB,IAFAQ,EAAOd,EAAoBgB,EAAK,CAAE,EAClCD,EAAMZ,EAAeO,CAAE,EACjBS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,CAAE,EACdL,EAAMK,CAAE,EAAI,EAEZL,EAAMK,CAAE,EAAI,EAGd,OAAOH,CACR,CAEA,OAAAf,EAAOgB,EAAKP,EAAG,EAAGM,EAAK,CAAE,EAClBA,CACR,CAKAtB,EAAO,QAAUe,ICvMjB,IAAIW,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "getType", "ctors", "reinterpret128", "reinterpret64", "reinterpretBoolean", "gcopy", "copy", "resolveGetter", "format", "isComplex64", "dtype", "isComplex128", "isBool", "convert", "x", "isc64", "ctor", "xbuf", "obuf", "get", "out", "len", "t", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a822c0c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,26 +0,0 @@ - -{{alias}}( arr, dtype ) - Converts an input array to an array of a different data type. - - Parameters - ---------- - arr: ArrayLikeObject - Array to convert. - - dtype: string - Output data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var arr = [ 1.0, 2.0, 3.0, 4.0 ]; - > var out = {{alias}}( arr, 'float32' ) - [ 1.0, 2.0, 3.0, 4.0 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 6306c6c..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,68 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 convert = require( './index' ); - - -// TESTS // - -// The function returns an array or typed array... -{ - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64' ); // $ExpectType Float64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float32' ); // $ExpectType Float32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int32' ); // $ExpectType Int32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int16' ); // $ExpectType Int16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'int8' ); // $ExpectType Int8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint32' ); // $ExpectType Uint32Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint16' ); // $ExpectType Uint16Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8' ); // $ExpectType Uint8Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'uint8c' ); // $ExpectType Uint8ClampedArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex128' ); // $ExpectType Complex128Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ); // $ExpectType Complex64Array - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'bool' ); // $ExpectType BooleanArray - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'generic' ); // $ExpectType number[] - convert( [ 'a', 'b', 'c', 'd' ], 'generic' ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not array-like... -{ - convert( 123, 'float64' ); // $ExpectError - convert( true, 'float64' ); // $ExpectError - convert( false, 'float64' ); // $ExpectError - convert( {}, 'float64' ); // $ExpectError - convert( null, 'float64' ); // $ExpectError - convert( undefined, 'float64' ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a known data type... -{ - convert( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError - convert( [ 1, 2, 3, 4 ], 123 ); // $ExpectError - convert( [ 1, 2, 3, 4 ], [] ); // $ExpectError - convert( [ 1, 2, 3, 4 ], {} ); // $ExpectError - convert( [ 1, 2, 3, 4 ], true ); // $ExpectError - convert( [ 1, 2, 3, 4 ], false ); // $ExpectError - convert( [ 1, 2, 3, 4 ], null ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - convert(); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ] ); // $ExpectError - convert( [ 1.0, 2.0, 3.0, 4.0 ], 'float64', 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ac4102b..0000000 --- a/examples/index.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array-filled-by' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var convert = require( './../lib' ); - -// Create a generic array: -var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) ); - -// Get a list of array data types: -var DTYPES = dtypes(); - -// Convert the generic array to each array data type: -var out; -var i; -for ( i = 0; i < DTYPES.length; i++ ) { - out = convert( arr, DTYPES[ i ] ); - console.log( out ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index ea0c1d7..687e7cd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, DataTypeMap } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0abb169 --- /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/assert-is-collection@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@v0.3.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex128@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-complex64@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@v0.0.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-base-gcopy@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-resolve-getter@v0.2.2-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function p(r){return"complex64"===r}function j(r){return"complex128"===r}function f(r){return"bool"===r}function c(c,h){var v,a,b,u,g,x,y,w,E;if(!r(c))throw new TypeError(l("00V2O",c));if("generic"===h)return o(c);if(null===(a=t(h)))throw new TypeError(l("00V2P",h));if(y=c.length,v=p(w=e(c)),x=new a(y),v||j(w)){if(b=v?i(c,0):s(c,0),p(h))return u=i(x,0),d(2*y,b,1,u,1),x;if(j(h))return u=s(x,0),d(2*y,b,1,u,1),x;if(f(h)){for(u=n(x,0),E=0;E[ 1.0, 2.0, 3.0, 4.0 ]\n*/\nfunction convert( x, dtype ) {\n\tvar isc64;\n\tvar ctor;\n\tvar xbuf;\n\tvar obuf;\n\tvar get;\n\tvar out;\n\tvar len;\n\tvar t;\n\tvar i;\n\n\tif ( !isCollection( x ) ) {\n\t\tthrow new TypeError( format( '00V2O', x ) );\n\t}\n\t// If the output data type is \"generic\", our task is relatively straightforward...\n\tif ( dtype === 'generic' ) {\n\t\treturn copy( x );\n\t}\n\tctor = ctors( dtype );\n\tif ( ctor === null ) {\n\t\tthrow new TypeError( format( '00V2P', dtype ) );\n\t}\n\t// Cache the input array length:\n\tlen = x.length;\n\n\t// Get the input array data type:\n\tt = getType( x );\n\tisc64 = isComplex64( t );\n\n\t// Create the output array:\n\tout = new ctor( len );\n\n\t// As the output data type is not \"generic\", we need to explicitly handle complex number input arrays...\n\tif ( isc64 || isComplex128( t ) ) {\n\t\tif ( isc64 ) {\n\t\t\txbuf = reinterpret64( x, 0 );\n\t\t} else {\n\t\t\txbuf = reinterpret128( x, 0 );\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // cmplx => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len*2, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // cmplx => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\t\t// A complex number is only falsy when both the real and imaginary components are zero...\n\t\t\t\tif ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) {\n\t\t\t\t\tobuf[ i ] = 1;\n\t\t\t\t} else {\n\t\t\t\t\tobuf[ i ] = 0;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn out;\n\t\t}\n\t\t// We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array...\n\t\tgcopy( len, xbuf, 2, out, 1 ); // cmplx => real\n\t\treturn out;\n\t}\n\t// Check whether the input array is a boolean array...\n\tif ( isBool( t ) ) {\n\t\txbuf = reinterpretBoolean( x, 0 );\n\n\t\t// Check whether the output data type is a boolean data type...\n\t\tif ( isBool( dtype ) ) { // bool => bool\n\t\t\tobuf = reinterpretBoolean( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 1 );\n\t\t\treturn out;\n\t\t}\n\t\t// Check whether the output data type is a complex number data type...\n\t\tif ( isComplex64( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tif ( isComplex128( dtype ) ) { // bool => cmplx\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t\tgcopy( len, xbuf, 1, obuf, 2 );\n\t\t\treturn out;\n\t\t}\n\t\tgcopy( len, xbuf, 1, out, 1 ); // bool => real\n\t\treturn out;\n\t}\n\t// Check whether we need to explicitly handle complex number output arrays...\n\tisc64 = isComplex64( dtype );\n\tif ( isc64 || isComplex128( dtype ) ) {\n\t\tif ( isc64 ) {\n\t\t\tobuf = reinterpret64( out, 0 );\n\t\t} else {\n\t\t\tobuf = reinterpret128( out, 0 );\n\t\t}\n\t\t// We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!)\n\t\tgcopy( len, x, 1, obuf, 2 ); // real => cmplx\n\t\treturn out;\n\t}\n\t// Check whether the output data type is a boolean data type...\n\tif ( isBool( dtype ) ) {\n\t\tobuf = reinterpretBoolean( out, 0 );\n\t\tget = resolveGetter( x );\n\t\tfor ( i = 0; i < len; i++ ) {\n\t\t\tif ( get( x, i ) ) {\n\t\t\t\tobuf[ i ] = 1;\n\t\t\t} else {\n\t\t\t\tobuf[ i ] = 0;\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\t// At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy...\n\tgcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default convert;\n"],"names":["isComplex64","dtype","isComplex128","isBool","convert","x","isc64","ctor","xbuf","obuf","get","out","len","t","i","isCollection","TypeError","format","copy","ctors","length","getType","reinterpret64","reinterpret128","gcopy","reinterpretBoolean","resolveGetter"],"mappings":";;08BAmDA,SAASA,EAAaC,GACrB,MAAmB,cAAVA,CACV,CAiBA,SAASC,EAAcD,GACtB,MAAmB,eAAVA,CACV,CAiBA,SAASE,EAAQF,GAChB,MAAmB,SAAVA,CACV,CAoBA,SAASG,EAASC,EAAGJ,GACpB,IAAIK,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAcV,GACnB,MAAM,IAAIW,UAAWC,EAAQ,QAASZ,IAGvC,GAAe,YAAVJ,EACJ,OAAOiB,EAAMb,GAGd,GAAc,QADdE,EAAOY,EAAOlB,IAEb,MAAM,IAAIe,UAAWC,EAAQ,QAAShB,IAavC,GAVAW,EAAMP,EAAEe,OAIRd,EAAQN,EADRa,EAAIQ,EAAShB,IAIbM,EAAM,IAAIJ,EAAMK,GAGXN,GAASJ,EAAcW,GAAM,CAOjC,GALCL,EADIF,EACGgB,EAAejB,EAAG,GAElBkB,EAAgBlB,EAAG,GAGtBL,EAAaC,GAGjB,OAFAQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAER,GAAKT,EAAcD,GAGlB,OAFAQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAW,EAAJZ,EAAOJ,EAAM,EAAGC,EAAM,GACtBE,EAGR,GAAKR,EAAQF,GAAU,CAEtB,IADAQ,EAAOgB,EAAoBd,EAAK,GAC1BG,EAAI,EAAGA,EAAIF,EAAKE,IAEhBN,EAAM,EAAEM,IAAON,EAAO,EAAEM,EAAG,GAC/BL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,CACP,CAED,GAAKR,EAAQU,GAIZ,OAHAL,EAAOiB,EAAoBpB,EAAG,GAGzBF,EAAQF,IACZQ,EAAOgB,EAAoBd,EAAK,GAChCa,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAGHX,EAAaC,IACjBQ,EAAOa,EAAeX,EAAK,GAC3Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,GAEHT,EAAcD,IAClBQ,EAAOc,EAAgBZ,EAAK,GAC5Ba,EAAOZ,EAAKJ,EAAM,EAAGC,EAAM,GACpBE,IAERa,EAAOZ,EAAKJ,EAAM,EAAGG,EAAK,GACnBA,GAIR,IADAL,EAAQN,EAAaC,KACPC,EAAcD,GAQ3B,OANCQ,EADIH,EACGgB,EAAeX,EAAK,GAEpBY,EAAgBZ,EAAK,GAG7Ba,EAAOZ,EAAKP,EAAG,EAAGI,EAAM,GACjBE,EAGR,GAAKR,EAAQF,GAAU,CAGtB,IAFAQ,EAAOgB,EAAoBd,EAAK,GAChCD,EAAMgB,EAAerB,GACfS,EAAI,EAAGA,EAAIF,EAAKE,IAChBJ,EAAKL,EAAGS,GACZL,EAAMK,GAAM,EAEZL,EAAMK,GAAM,EAGd,OAAOH,CACP,CAGD,OADAa,EAAOZ,EAAKP,EAAG,EAAGM,EAAK,GAChBA,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4b0267f..0000000 --- a/lib/index.js +++ /dev/null @@ -1,42 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an array to an array of a different data type. -* -* @module @stdlib/array-convert -* -* @example -* var convert = require( '@stdlib/array-convert' ); -* -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 128a695..0000000 --- a/lib/main.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isCollection = require( '@stdlib/assert-is-collection' ); -var getType = require( '@stdlib/array-dtype' ); -var ctors = require( '@stdlib/array-ctors' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var gcopy = require( '@stdlib/blas-base-gcopy' ); -var copy = require( '@stdlib/array-base-copy' ); -var resolveGetter = require( '@stdlib/array-base-resolve-getter' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// FUNCTIONS // - -/** -* Tests whether a data type is a single-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a single-precision complex floating-point number data type -* -* @example -* var bool = isComplex64( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex64( 'complex64' ); -* // returns true -*/ -function isComplex64( dtype ) { - return ( dtype === 'complex64' ); -} - -/** -* Tests whether a data type is a double-precision complex floating-point number data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a double-precision complex floating-point number data type -* -* @example -* var bool = isComplex128( 'float64' ); -* // returns false -* -* @example -* var bool = isComplex128( 'complex128' ); -* // returns true -*/ -function isComplex128( dtype ) { - return ( dtype === 'complex128' ); -} - -/** -* Tests whether a data type is a boolean data type. -* -* @private -* @param {string} dtype - data type -* @returns {boolean} boolean indicating whether a provided data type is a boolean data type -* -* @example -* var bool = isBool( 'bool' ); -* // returns true -* -* @example -* var bool = isBool( 'complex128' ); -* // returns false -*/ -function isBool( dtype ) { - return ( dtype === 'bool' ); -} - - -// MAIN // - -/** -* Converts an array to an array of a different data type. -* -* @param {Collection} x - array to convert -* @param {string} dtype - output data type -* @throws {TypeError} first argument must be an array-like object -* @throws {TypeError} second argument must be a recognized array data type -* @returns {(Array|TypedArray|ComplexArray)} output array -* -* @example -* var arr = [ 1.0, 2.0, 3.0, 4.0 ]; -* -* var out = convert( arr, 'float64' ); -* // returns [ 1.0, 2.0, 3.0, 4.0 ] -*/ -function convert( x, dtype ) { - var isc64; - var ctor; - var xbuf; - var obuf; - var get; - var out; - var len; - var t; - var i; - - if ( !isCollection( x ) ) { - throw new TypeError( format( '00V2O', x ) ); - } - // If the output data type is "generic", our task is relatively straightforward... - if ( dtype === 'generic' ) { - return copy( x ); - } - ctor = ctors( dtype ); - if ( ctor === null ) { - throw new TypeError( format( '00V2P', dtype ) ); - } - // Cache the input array length: - len = x.length; - - // Get the input array data type: - t = getType( x ); - isc64 = isComplex64( t ); - - // Create the output array: - out = new ctor( len ); - - // As the output data type is not "generic", we need to explicitly handle complex number input arrays... - if ( isc64 || isComplex128( t ) ) { - if ( isc64 ) { - xbuf = reinterpret64( x, 0 ); - } else { - xbuf = reinterpret128( x, 0 ); - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // cmplx => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - if ( isComplex128( dtype ) ) { // cmplx => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len*2, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // cmplx => bool - obuf = reinterpretBoolean( out, 0 ); - for ( i = 0; i < len; i++ ) { - // A complex number is only falsy when both the real and imaginary components are zero... - if ( xbuf[ 2*i ] || xbuf[ (2*i)+1 ] ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // We assume that the output data type is a real number data type, given that we're looking to convert a provided complex number array; in which case, we'll only extract the real components from the complex number input array... - gcopy( len, xbuf, 2, out, 1 ); // cmplx => real - return out; - } - // Check whether the input array is a boolean array... - if ( isBool( t ) ) { - xbuf = reinterpretBoolean( x, 0 ); - - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { // bool => bool - obuf = reinterpretBoolean( out, 0 ); - gcopy( len, xbuf, 1, obuf, 1 ); - return out; - } - // Check whether the output data type is a complex number data type... - if ( isComplex64( dtype ) ) { // bool => cmplx - obuf = reinterpret64( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - if ( isComplex128( dtype ) ) { // bool => cmplx - obuf = reinterpret128( out, 0 ); - gcopy( len, xbuf, 1, obuf, 2 ); - return out; - } - gcopy( len, xbuf, 1, out, 1 ); // bool => real - return out; - } - // Check whether we need to explicitly handle complex number output arrays... - isc64 = isComplex64( dtype ); - if ( isc64 || isComplex128( dtype ) ) { - if ( isc64 ) { - obuf = reinterpret64( out, 0 ); - } else { - obuf = reinterpret128( out, 0 ); - } - // We assume that the input data type is a real number data type, given that we're looking to convert to a complex number array; in which case, we'll only set the real components... (WARNING: we're assuming that the output array has been zero-initialized! The imaginary components should be zero!) - gcopy( len, x, 1, obuf, 2 ); // real => cmplx - return out; - } - // Check whether the output data type is a boolean data type... - if ( isBool( dtype ) ) { - obuf = reinterpretBoolean( out, 0 ); - get = resolveGetter( x ); - for ( i = 0; i < len; i++ ) { - if ( get( x, i ) ) { - obuf[ i ] = 1; - } else { - obuf[ i ] = 0; - } - } - return out; - } - // At this point, we're no longer handling complex number or boolean arrays, so we'll just assume that we can perform a straightforward copy... - gcopy( len, x, 1, out, 1 ); // note: `gcopy` is assumed to support arrays using accessors - return out; -} - - -// EXPORTS // - -module.exports = convert; diff --git a/package.json b/package.json index 2284d5a..3600fc9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert an array to an array of a different data type.", "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,76 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy": "^0.2.2", - "@stdlib/array-base-resolve-getter": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/blas-base-gcopy": "^0.2.1", - "@stdlib/strided-base-reinterpret-boolean": "^0.0.2", - "@stdlib/strided-base-reinterpret-complex128": "^0.2.2", - "@stdlib/strided-base-reinterpret-complex64": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-bool": "^0.1.0", - "@stdlib/array-complex128": "^0.3.0", - "@stdlib/array-complex64": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-int16": "^0.2.2", - "@stdlib/array-int32": "^0.2.2", - "@stdlib/array-int8": "^0.2.2", - "@stdlib/array-uint16": "^0.2.2", - "@stdlib/array-uint32": "^0.2.2", - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/array-uint8c": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-booleanarray": "^0.0.2", - "@stdlib/assert-is-complex128": "^0.2.2", - "@stdlib/assert-is-complex128array": "^0.2.2", - "@stdlib/assert-is-complex64": "^0.2.2", - "@stdlib/assert-is-complex64array": "^0.2.2", - "@stdlib/assert-is-float32array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/assert-is-int16array": "^0.2.2", - "@stdlib/assert-is-int32array": "^0.2.2", - "@stdlib/assert-is-int8array": "^0.2.2", - "@stdlib/assert-is-uint16array": "^0.2.2", - "@stdlib/assert-is-uint32array": "^0.2.2", - "@stdlib/assert-is-uint8array": "^0.2.2", - "@stdlib/assert-is-uint8clampedarray": "^0.2.2", - "@stdlib/complex-float32-imag": "^0.1.1", - "@stdlib/complex-float32-real": "^0.1.1", - "@stdlib/complex-float64-imag": "^0.1.1", - "@stdlib/complex-float64-real": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-discrete-uniform": "^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..205e697 --- /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.js b/test/test.js deleted file mode 100644 index cb88546..0000000 --- a/test/test.js +++ /dev/null @@ -1,712 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-len */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Int16Array = require( '@stdlib/array-int16' ); -var Int32Array = require( '@stdlib/array-int32' ); -var Int8Array = require( '@stdlib/array-int8' ); -var Uint16Array = require( '@stdlib/array-uint16' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var Complex64Array = require( '@stdlib/array-complex64' ); -var BooleanArray = require( '@stdlib/array-bool' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var isFloat32Array = require( '@stdlib/assert-is-float32array' ); -var isInt16Array = require( '@stdlib/assert-is-int16array' ); -var isInt32Array = require( '@stdlib/assert-is-int32array' ); -var isInt8Array = require( '@stdlib/assert-is-int8array' ); -var isUint16Array = require( '@stdlib/assert-is-uint16array' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var isUint8Array = require( '@stdlib/assert-is-uint8array' ); -var isUint8ClampedArray = require( '@stdlib/assert-is-uint8clampedarray' ); -var isComplex64Array = require( '@stdlib/assert-is-complex64array' ); -var isComplex128Array = require( '@stdlib/assert-is-complex128array' ); -var isBooleanArray = require( '@stdlib/assert-is-booleanarray' ); -var isComplex64 = require( '@stdlib/assert-is-complex64' ); -var isComplex128 = require( '@stdlib/assert-is-complex128' ); -var reinterpret64 = require( '@stdlib/strided-base-reinterpret-complex64' ); -var reinterpret128 = require( '@stdlib/strided-base-reinterpret-complex128' ); -var reinterpretBoolean = require( '@stdlib/strided-base-reinterpret-boolean' ); -var real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var realf = require( '@stdlib/complex-float32-real' ); -var imagf = require( '@stdlib/complex-float32-imag' ); -var convertArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof convertArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if not provided an array-like object as its first argument, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 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() { - convertArray( value, 'float64' ); - }; - } -}); - -tape( 'if provided an unknown/unsupported data type, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - 'binary', - 'buffer', - 'buf', - 'float', - 'double', - 'single', - 'int', - 'integer', - 'uint', - 'uinteger', - 'byte', - 'bits' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - convertArray( [ 1, 2, 3 ], value ); - }; - } -}); - -tape( 'the function converts an array to an array of a different data type', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = [ -1, 0, 1 ]; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ arr, isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ [ -1, 0, 1 ], isArray ], - [ new Int16Array( [ -1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (generic => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ 'foo', null, [], {} ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = [ -1, 0, 1, 2 ]; - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (accessors => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = { - 'length': 3, - 'data': [ -1, 0, 1 ], - 'get': getter, - 'set': setter - }; - expected = new Uint8Array( [ 1, 0, 1 ] ); - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); - - function getter( idx ) { - return arr.data[ idx ]; - } - - function setter( value, idx ) { - arr.data[ idx ] = value; - } -}); - -tape( 'the function converts an array to an array of a different data type (bool => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - [ new Complex64Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (real => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = [ -1, 0, 1, 2 ]; - expected = [ - [ new Complex64Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => complex)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var tmp; - var v1; - var v2; - var i; - var j; - - dtypes = [ - 'complex64', - 'complex128' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex64Array, reinterpret64 ], - [ new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ), isComplex128Array, reinterpret128 ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - tmp = expected[ i ]; - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( tmp[ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - v1 = tmp[ 2 ]( out, 0 ); - v2 = tmp[ 2 ]( tmp[ 0 ], 0 ); - for ( j = 0; j < arr.length*2; j += 2 ) { - t.strictEqual( v1[ j ], v2[ j ], 'returns expected real component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - t.strictEqual( v1[ j+1 ], v2[ j+1 ], 'returns expected imaginary component for element ' + (j/2) + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => bool)', function test( t ) { - var expected; - var arr; - var out; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 0.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.strictEqual( isBooleanArray( out ), true, 'returns expected value type' ); - t.strictEqual( out.length, expected.length, 'returns expected length' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - [ new Float64Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat64Array ], - [ new Float32Array( [ -1.0, 0.0, 1.0, 2.0 ] ), isFloat32Array ], - [ new Int16Array( [ -1, 0, 1, 2 ] ), isInt16Array ], - [ new Int32Array( [ -1, 0, 1, 2 ] ), isInt32Array ], - [ new Int8Array( [ -1, 0, 1, 2 ] ), isInt8Array ], - [ new Uint16Array( [ 65535, 0, 1, 2 ] ), isUint16Array ], - [ new Uint32Array( [ 4294967295, 0, 1, 2 ] ), isUint32Array ], - [ new Uint8Array( [ 255, 0, 1, 2 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 0, 0, 1, 2 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => real)', function test( t ) { - var expected; - var dtypes; - var arr; - var out; - var i; - var j; - - dtypes = [ - 'float64', - 'float32', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c' - ]; - arr = new BooleanArray( [ true, false, true ] ); - expected = [ - [ new Float64Array( [ 1.0, 0.0, 1.0 ] ), isFloat64Array ], - [ new Float32Array( [ 1.0, 0.0, 1.0 ] ), isFloat32Array ], - [ new Int16Array( [ 1, 0, 1 ] ), isInt16Array ], - [ new Int32Array( [ 1, 0, 1 ] ), isInt32Array ], - [ new Int8Array( [ 1, 0, 1 ] ), isInt8Array ], - [ new Uint16Array( [ 1, 0, 1 ] ), isUint16Array ], - [ new Uint32Array( [ 1, 0, 1 ] ), isUint32Array ], - [ new Uint8Array( [ 1, 0, 1 ] ), isUint8Array ], - [ new Uint8ClampedArray( [ 1, 0, 1 ] ), isUint8ClampedArray ] - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ][ 1 ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - for ( j = 0; j < arr.length; j++ ) { - t.strictEqual( out[ j ], expected[ i ][ 0 ][ j ], 'returns expected element ' + j + ' for ' + dtypes[ i ] ); - } - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => generic)', function test( t ) { - var expected; - var arr; - var out; - var i; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - t.strictEqual( out[ i ], expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (bool => bool)', function test( t ) { - var expected; - var out; - var arr; - - arr = new BooleanArray( [ true, false, true, true ] ); - expected = new Uint8Array( [ 1, 0, 1, 1 ] ); - - out = convertArray( arr, 'bool' ); - t.deepEqual( out.length, expected.length, 'returns expected value' ); - t.deepEqual( reinterpretBoolean( out, 0 ), expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex64 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex64Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex64( v1 ), true, 'returns expected value' ); - t.strictEqual( realf( v1 ), realf( v2 ), 'returns expected real component' ); - t.strictEqual( imagf( v1 ), imagf( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (complex128 => generic)', function test( t ) { - var expected; - var arr; - var out; - var v1; - var v2; - var i; - - arr = new Complex128Array( [ -1.0, 1.0, 0.0, 2.0, 1.0, 3.0, 2.0, 4.0 ] ); - expected = [ - arr.get( 0 ), - arr.get( 1 ), - arr.get( 2 ), - arr.get( 3 ) - ]; - out = convertArray( arr, 'generic' ); - t.strictEqual( isArray( out ), true, 'returns expected value type' ); - for ( i = 0; i < arr.length; i++ ) { - v1 = out[ i ]; - v2 = expected[ i ]; - t.strictEqual( isComplex128( v1 ), true, 'returns expected value' ); - t.strictEqual( real( v1 ), real( v2 ), 'returns expected real component' ); - t.strictEqual( imag( v1 ), imag( v2 ), 'returns expected imaginary component' ); - } - t.end(); -}); - -tape( 'the function converts an array to an array of a different data type (large allocations)', function test( t ) { - var expected; - var dtypes; - var out; - var arr; - var i; - - dtypes = [ - 'float64', - 'float32', - 'generic', - 'int16', - 'int32', - 'int8', - 'uint16', - 'uint32', - 'uint8', - 'uint8c', - 'complex64', - 'complex128', - 'bool' - ]; - arr = []; - for ( i = 0; i < 1e6; i++ ) { - arr.push( 0 ); - } - expected = [ - isFloat64Array, - isFloat32Array, - isArray, - isInt16Array, - isInt32Array, - isInt8Array, - isUint16Array, - isUint32Array, - isUint8Array, - isUint8ClampedArray, - isComplex64Array, - isComplex128Array, - isBooleanArray - ]; - for ( i = 0; i < dtypes.length; i++ ) { - out = convertArray( arr, dtypes[ i ] ); - t.strictEqual( expected[ i ]( out ), true, 'returns expected value type for ' + dtypes[ i ] ); - } - t.end(); -});