All files / struct-factory/lib index.js

100% Statements 107/107
100% Branches 1/1
100% Functions 0/0
100% Lines 107/107

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 1081x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
/**
* Return a constructor for creating arrays having a fixed-width composite data type.
*
* @module @stdlib/array/struct-factory
*
* @example
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var structFactory = require( '@stdlib/dstructs/struct' );
* var factory = require( '@stdlib/array/struct-factory' );
*
* var schema1 = [
*     {
*         'name': 're',
*         'type': 'float64'
*     },
*     {
*         'name': 'im',
*         'type': 'float64'
*     }
* ];
*
* // Create a struct constructor for storing real and imaginary components:
* var Components = structFactory( schema1 );
*
* var schema2 = [
*     {
*         'type': 'union',
*         'fields': [
*             {
*                 'name': 'value',
*                 'type': 'complex128'
*             },
*             {
*                 'name': 'components',
*                 'type': Components
*             }
*         ]
*     }
* ];
*
* // Create a struct constructor for storing a double-precision complex number:
* var Complex128Struct = structFactory( schema2 );
*
* // Create an array constructor for storing complex numbers:
* var Complex128Array = factory( Complex128Struct );
*
* // Create a new array:
* var x = new Complex128Array( 10 );
* // returns <StructArray>
*
* // Retrieve the first element:
* var v1 = x.get( 0 );
*
* // Resolve the complex number stored within the first element:
* var z1 = v1.value;
* // returns <Complex128>[ 0.0, 0.0 ]
*
* // Resolve the individual real and imaginary components:
* var z2 = v1.components;
*
* var re = z2.re;
* // returns 0.0
*
* var im = z2.im;
* // returns 0.0
*
* // Create a new complex number struct:
* var z3 = new Complex128Struct({
*     'value': new Complex128( 3.0, 5.0 )
* });
*
* // Update the first element of the array:
* x.set( z3, 0 );
*
* // As `v1` is a view on same memory as the first element, resolve the complex number stored within the element:
* var z4 = v1.value;
* // returns <Complex128>[ 3.0, 5.0 ]
*/
 
// MODULES //
 
var main = require( './main.js' );
 
 
// EXPORTS //
 
module.exports = main;