About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Return a constructor for creating arrays having a fixed-width composite data type.
npm install @stdlib/array-struct-factoryAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch (see README). - If you are using Deno, visit the
denobranch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch (see README).
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var structFactory = require( '@stdlib/array-struct-factory' );Returns a constructor for creating arrays having a fixed-width composite data type.
var schema = [
{
'name': 'beep',
'type': 'float64'
},
{
'name': 'boop',
'type': 'int32'
}
];
var StructArray = structFactory( schema );
// returns <Function>The function supports the following parameters:
TODO: add documentation of constructor
Number of bytes per view element.
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var nbytes = StructArray.BYTES_PER_ELEMENT;
// returns 1Array constructor name.
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var str = StructArray.name;
// returns 'StructArray'Read-only property which returns the ArrayBuffer referenced by the array.
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var buf = arr.buffer;
// returns <ArrayBuffer>Read-only property which returns the length (in bytes) of the array.
var schema = [
{
'name': 'foo',
'type': 'int32'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var byteLength = arr.byteLength;
// returns 20Read-only property which returns the offset (in bytes) of the array from the start of its ArrayBuffer.
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var byteOffset = arr.byteOffset;
// returns 0Number of bytes per view element.
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var nbytes = arr.BYTES_PER_ELEMENT;
// returns 1Read-only property which returns the number of view elements.
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var len = arr.length;
// returns 5TODO: document methods
-
While returned constructors strive to maintain (but do not guarantee) consistency with typed arrays, significant deviations from ECMAScript-defined typed array behavior are as follows:
- Constructors do not require the
newoperator. - Accessing array elements using bracket syntax (e.g.,
X[i]) is not supported. Instead, one must use the.get()method. - Accessed array elements are a view on underlying memory. Thus, mutation of accessed elements mutates the underlying buffer.
- Constructors do not require the
-
Struct arrays share several similarities with generic arrays containing objects (e.g., nested property access); however, the principal difference is that struct arrays are strongly typed and backed by fixed memory. Struct arrays are particularly well-suited for zero-copy transfer of data stored in composite data types when interoperating between JavaScript and C.
var factory = require( '@stdlib/array-struct-factory' );
// Define a schema for a composite data type for storing a student's test scores:
var schema = [
{
'name': 'test_number',
'type': 'int16'
},
{
'name': 'pass',
'type': 'bool'
},
{
'name': 'correct',
'type': 'int32'
},
{
'name': 'incorrect',
'type': 'int32'
},
{
'name': 'percentage',
'type': 'float32'
}
];
// Create an array constructor for creating composite data type arrays:
var TestScoreArray = factory( schema );
console.log( 'Layout: %s', TestScoreArray.struct.layout );
// Create a new array for storing test scores:
var student1 = new TestScoreArray( 10 );
console.log( 'Byte length: %d', student1.byteLength );This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
See LICENSE.
Copyright © 2016-2026. The Stdlib Authors.