Data

Tools

Indexes

Applications

Experiments

Open Source Science

dstructs-struct

Fixed-width composite data type (a.k.a., a `struct`).

https://github.com/stdlib-js/dstructs-struct

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.9%) to scientific vocabulary

Keywords

c composite data data-structure data-structures dataview fixed-width javascript node node-js nodejs stdlib structure type
Last synced: 6 months ago · JSON representation ·

Repository

Fixed-width composite data type (a.k.a., a `struct`).

Basic Info
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
c composite data data-structure data-structures dataview fixed-width javascript node node-js nodejs stdlib structure type
Created 8 months ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

struct

NPM version Build Status Coverage Status <!-- dependencies -->

Fixed-width composite data type (a.k.a., a struct).

## Installation ```bash npm install @stdlib/dstructs-struct ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] 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.
## Usage ```javascript var struct = require( '@stdlib/dstructs-struct' ); ``` #### struct( schema ) Returns a constructor for creating a fixed-width composite data type (a.k.a., a `struct`). ```javascript var fields = [ { 'type': 'union', 'fields': [ { 'name': 'double', 'description': 'double-precision floating-point number', 'type': 'float64', 'enumerable': true, 'writable': true, 'castingMode': 'none' }, { 'name': 'words', 'description': 'high and low words', 'type': 'uint32', 'length': 2, 'enumerable': true, 'writable': true, 'castingMode': 'none' } ] } ]; var Struct = struct( fields ); var data = { 'double': 3.14 }; var s = new Struct( data ); // returns var v = s.double; // returns 3.14 var w = s.words; // e.g., [ 1374389535, 1074339512 ] ``` TODO: document schema TODO: document constructor API
## Notes - While struct instances aim to emulate C `struct` behavior, structs have the following differences: - The struct schema supports default values. In C, uninitialized members are zero-filled. - The struct schema supports "casting modes", which govern member assignment operations and support placing (or relaxing) strict requirements on what types of values may be assigned to struct members. In C, members have no such limitations, with the C compiler performing implicit casting (e.g., a signed integer will be implicitly cast to an unsigned integer when a member has an unsigned integer data type). - Only fixed-width types are supported (e.g., `int8`, `float64`, etc). In C, members can have types which may vary across platforms (e.g., `int`, `enum`, `long double`, etc). - Member types must be serializable to an ArrayBuffer (e.g., no functions, general objects, etc). In C, members have no such limitations (e.g., a member can be a function pointer). - Union types must all have the same byte length. In C, members of union types can have different byte lengths. - struct instances can have "hidden" (i.e., non-enumerable) fields. In C, all members are part of a `struct`'s public API. - struct instances can have read-only fields. In C, one can use a `const` qualifier to prevent assignment after initialization; however, one can circumvent this restriction using pointer tricks. - Member types can have an associated description, which is useful when wanting to inspect struct instances in interactive contexts, such as REPLs. - struct instances support string and JSON serialization. - A primary use case for emulating C `struct` behavior is to facilitate interoperation between JavaScript and C. For example, by creating a JavaScript struct instance which has the same alignment and layout as a C `struct`, one can pass a pointer to a struct instance's underlying byte buffer from JavaScript to C and then simply perform a cast to interpret as an equivalent C `struct`. This enables zero-copy interchange when, e.g., calling into Node.js native native add-ons and can greatly reduce overhead when working with heterogeneous composite data types.
## Examples ```javascript var Float64Array = require( '@stdlib/array-float64' ); var struct = require( '@stdlib/dstructs-struct' ); var fields = [ { 'name': 'rejected', 'description': 'boolean indicating whether the null hypothesis was rejected', 'type': 'bool', 'enumerable': true, 'writable': false, 'castingMode': 'none' }, { 'name': 'alpha', 'description': 'significance level', 'type': 'float64', 'enumerable': true, 'writable': false, 'castingMode': 'mostly-safe' }, { 'name': 'pValue', 'description': 'p-value', 'type': 'float64', 'enumerable': true, 'writable': false, 'castingMode': 'mostly-safe' }, { 'name': 'statistic', 'description': 'test statistic', 'type': 'float64', 'writable': false, 'castingMode': 'mostly-safe' }, { 'name': 'ci', 'description': 'confidence interval', 'type': 'float64', 'length': 2, 'enumerable': true, 'writable': false, 'castingMode': 'mostly-safe' }, { 'name': 'df', 'description': 'degrees of freedom', 'type': 'int32', 'enumerable': true, 'writable': false, 'castingMode': 'mostly-safe' }, { 'name': 'nullValue', 'description': 'null value', 'type': 'float64', 'enumerable': true, 'writable': false, 'castingMode': 'mostly-safe' }, { 'name': 'mean', 'description': 'computed mean', 'type': 'float64', 'enumerable': true, 'writable': false, 'castingMode': 'mostly-safe' }, { 'name': 'sd', 'description': 'standard error of the mean', 'type': 'float64', 'enumerable': true, 'writable': false, 'castingMode': 'mostly-safe' } ]; var Struct = struct( fields ); var s = new Struct({ 'rejected': true, 'alpha': 0.05, 'pValue': 0.01, 'statistic': 3.14, 'ci': new Float64Array( [ -5.0, 5.0 ] ), 'df': 10, 'nullValue': 1.0, 'mean': 1.01, 'sd': 0.025 }); // returns var byteLength = Struct.byteLength; console.log( 'Byte length: %d', byteLength ); var alignment = Struct.alignment; console.log( 'Alignment: %d', alignment ); var names = Struct.fields; console.log( 'Field names: %s', names.join( ', ' ) ); var str = s.toString({ 'format': 'linear' }); console.log( 'String:\n%s', str ); var o = s.toJSON(); console.log( o ); var offset = Struct.byteOffsetOf( 'alpha' ); console.log( 'Offset: %d', offset ); var desc = Struct.descriptionOf( 'alpha' ); console.log( 'Description: %s', desc ); ```
* * * ## 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. 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-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 23
  • Create event: 4
Last Year
  • Push event: 23
  • Create event: 4

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 14
  • Total Committers: 1
  • Avg Commits per committer: 14.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 14
  • Committers: 1
  • Avg Commits per committer: 14.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 14
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/benchmark.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite
.github/workflows/examples.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/productionize.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • JS-DevTools/npm-publish 19c28f1ef146469e409470805ea4279d47c3d35c composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/test.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_bundles.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite
.github/workflows/test_coverage.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/test_install.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_published_package.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
package.json npm
  • @stdlib/array-float64 ^0.2.2 development
  • @stdlib/bench-harness ^0.2.2 development
  • @stdlib/complex-float64-ctor ^0.0.3 development
  • @stdlib/number-float64-base-to-words ^0.2.2 development
  • istanbul ^0.4.1 development
  • tap-min git+https://github.com/Planeshifter/tap-min.git development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/array-base-assert-contains ^0.2.2
  • @stdlib/array-base-assert-is-boolean-data-type ^0.0.1
  • @stdlib/array-base-assert-is-complex-floating-point-data-type ^0.2.1
  • @stdlib/array-base-assert-is-real-data-type ^0.2.1
  • @stdlib/array-base-assert-is-real-floating-point-data-type ^0.2.1
  • @stdlib/array-base-assert-is-signed-integer-data-type ^0.2.1
  • @stdlib/array-base-filled ^0.2.2
  • @stdlib/array-base-index-of ^0.2.2
  • @stdlib/array-base-join ^0.1.1
  • @stdlib/array-base-map github:stdlib-js/array-base-map#main
  • @stdlib/array-base-min-signed-integer-dtype ^0.2.2
  • @stdlib/array-buffer ^0.2.2
  • @stdlib/array-dataview ^0.2.2
  • @stdlib/array-dtype ^0.3.0
  • @stdlib/array-min-dtype ^0.3.0
  • @stdlib/array-to-json ^0.3.0
  • @stdlib/array-typed ^0.3.0
  • @stdlib/array-uint8 ^0.2.2
  • @stdlib/assert-has-own-property ^0.2.2
  • @stdlib/assert-has-property ^0.2.2
  • @stdlib/assert-is-arraybuffer ^0.2.2
  • @stdlib/assert-is-bigint ^0.2.2
  • @stdlib/assert-is-boolean ^0.2.2
  • @stdlib/assert-is-collection ^0.2.2
  • @stdlib/assert-is-complex-like ^0.2.2
  • @stdlib/assert-is-dataview ^0.2.2
  • @stdlib/assert-is-function ^0.2.2
  • @stdlib/assert-is-integer ^0.2.2
  • @stdlib/assert-is-little-endian ^0.2.2
  • @stdlib/assert-is-nonnegative-integer ^0.2.2
  • @stdlib/assert-is-number ^0.2.2
  • @stdlib/assert-is-object ^0.2.2
  • @stdlib/assert-is-plain-object ^0.2.2
  • @stdlib/assert-is-positive-integer ^0.2.2
  • @stdlib/assert-is-string ^0.2.2
  • @stdlib/bigint-ctor ^0.2.2
  • @stdlib/blas-base-gcopy ^0.2.1
  • @stdlib/blas-ext-base-gfill ^0.2.1
  • @stdlib/boolean-ctor ^0.2.2
  • @stdlib/complex-cmplx ^0.2.2
  • @stdlib/complex-dtype ^0.2.2
  • @stdlib/error-tools-fmtprodmsg ^0.2.2
  • @stdlib/math-base-special-fast-min ^0.3.0
  • @stdlib/math-base-special-floor ^0.2.3
  • @stdlib/ndarray-base-assert-is-allowed-data-type-cast ^0.2.2
  • @stdlib/ndarray-base-bytes-per-element ^0.2.2
  • @stdlib/number-ctor ^0.2.2
  • @stdlib/strided-base-reinterpret-boolean ^0.0.2
  • @stdlib/strided-base-reinterpret-complex ^0.1.2
  • @stdlib/string-format ^0.2.2
  • @stdlib/utils-constant-function ^0.2.2
  • @stdlib/utils-define-nonenumerable-read-only-accessor ^0.2.3
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.2.2
  • @stdlib/utils-define-nonenumerable-read-write-accessor ^0.2.2
  • @stdlib/utils-define-read-only-accessor ^0.2.2
  • @stdlib/utils-define-read-write-accessor ^0.2.2