feat: add factory method for specifying defaults

Author: kgryte

lib/node_modules/@stdlib/array/to-fancy/README.md

@@ -114,6 +114,7 @@ v = y[ ':' ];
 The function supports the following options:
 
 -   **strict**: boolean indicating whether to enforce strict bounds checking. Default: `false`.
+-   **cache**: cache for resolving array index objects. Default: [`ArrayIndex`][@stdlib/array/index].
 
 By default, the function returns a fancy array which does **not** enforce strict bounds checking. For example,
 
@@ -137,16 +138,64 @@ var v = y[ 10 ];
 // throws <RangeError>
 ```
 
+#### array2fancy.factory( \[options] )
+
+Returns a function for converting an array to an object supporting fancy indexing.
+
+```javascript
+var fcn = array2fancy.factory();
+
+var x = [ 1, 2, 3, 4 ];
+
+var y = fcn( x );
+// returns <Array>
+
+var v = y[ ':' ];
+// returns [ 1, 2, 3, 4 ]
+```
+
+The function supports the following options:
+
+-   **strict**: boolean indicating whether to enforce strict bounds checking by default. Default: `false`.
+-   **cache**: cache for resolving array index objects. Default: [`ArrayIndex`][@stdlib/array/index].
+
+By default, the function returns a function which, by default, does **not** enforce strict bounds checking. For example,
+
+```javascript
+var fcn = array2fancy.factory();
+
+var y = fcn( [ 1, 2, 3, 4 ] );
+
+var v = y[ 10 ];
+// returns undefined
+```
+
+To enforce strict bounds checking by default, set the `strict` option to `true`.
+
+<!-- run throws: true -->
+
+```javascript
+var fcn = array2fancy.factory({
+    'strict': true
+});
+var y = fcn( [ 1, 2, 3, 4 ] );
+
+var v = y[ 10 ];
+// throws <RangeError>
+```
+
+The returned function supports the same options as above. When the returned function is provided option values, those values override the factory method defaults.
+
 </section>
 
 <!-- /.usage -->
 
 <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
-<section class="notes">
-
 * * *
 
+<section class="notes">
+
 ## Notes
 
 -   A fancy array shares the **same** data as the provided input array. Hence, any mutations to the returned array will affect the underlying input array and vice versa.
@@ -313,10 +362,10 @@ y[ ':' ] = new Float64Array( [ 5.0, 6.0 ] ); // is this a single complex number
 
 <!-- Package usage examples. -->
 
-<section class="examples">
-
 * * *
 
+<section class="examples">
+
 ## Examples
 
 <!-- eslint no-undef: "error" -->
@@ -388,6 +437,8 @@ z = y[ ':' ];
 
 [@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64
 
+[@stdlib/array/index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/index
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/array/to-fancy/benchmark/benchmark.factory.js

@@ -0,0 +1,48 @@
+/**
+* @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' );
+var isFunction = require( '@stdlib/assert/is-function' );
+var pkg = require( './../package.json' ).name;
+var array2fancy = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+':factory', function benchmark( b ) {
+	var v;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = array2fancy.factory();
+		if ( typeof v !== 'function' ) {
+			b.fail( 'should return a function' );
+		}
+	}
+	b.toc();
+	if ( !isFunction( v ) ) {
+		b.fail( 'should return a function' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/array/to-fancy/docs/repl.txt

@@ -69,6 +69,19 @@
         Boolean indicating whether to enforce strict bounds checking. Default:
         false.
 
+    options.cache: Object (optional)
+        Cache for resolving array index objects. Must have a 'get' method which
+        accepts a single argument: an identifier associated with an array index.
+        If an array index associated with a provided identifier exists, the
+        'get' method should return an object having the following properties:
+
+        - data: the underlying index array.
+        - type: the index type. Must be either 'mask', 'bool', or 'int'.
+        - dtype: the data type of the underlying array.
+
+        If an array index is not associated with a provided identifier, the
+        'get' method should return `null`.
+
     Returns
     -------
     out: Array|TypedArray|Object
@@ -82,6 +95,47 @@
     > y[ '::-1' ]
     [ 4, 3, 2, 1 ]
 
+
+{{alias}}.factory( [options] )
+    Returns a function for converting an array to an object supporting fancy
+    indexing.
+
+    Parameters
+    ----------
+    options: Object (optional)
+        Function options.
+
+    options.strict: boolean (optional)
+        Boolean indicating whether to enforce strict bounds checking by default.
+        Default: false.
+
+    options.cache: Object (optional)
+        Cache for resolving array index objects. Must have a 'get' method which
+        accepts a single argument: an identifier associated with an array index.
+        If an array index associated with a provided identifier exists, the
+        'get' method should return an object having the following properties:
+
+        - data: the underlying index array.
+        - type: the index type. Must be either 'mask', 'bool', or 'int'.
+        - dtype: the data type of the underlying array.
+
+        If an array index is not associated with a provided identifier, the
+        'get' method should return `null`.
+
+    Returns
+    -------
+    fcn: Function
+        Function for converting an array to an object supporting fancy indexing.
+
+    Examples
+    --------
+    > var f = {{alias}}.factory();
+    > var y = f( [ 1, 2, 3, 4 ] );
+    > y[ '1::2' ]
+    [ 2, 4 ]
+    > y[ '::-1' ]
+    [ 4, 3, 2, 1 ]
+
     See Also
     --------