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!
setProps
Define non-enumerable read-only properties which expose ndarray function meta data.
Installation
npm install @stdlib/ndarray-base-meta-data-propsUsage
var setProps = require( '@stdlib/ndarray-base-meta-data-props' );setProps( meta, dtypes, obj )
Defines non-enumerable read-only properties which expose ndarray function meta data.
// Define ndarray function meta data:
var meta = {
'nargs': 2,
'nin': 1,
'nout': 1
};
// Define the list of ndarray data types:
var dtypes = [
'float64', 'float64'
];
// Define an object/function on which to set the properties:
var obj = {};
// Set the properties:
setProps( meta, dtypes, obj );The meta data argument should be an object with the following properties:
- nargs: total number of arguments. This value is one more than might be expected, as the output array is treated as an implicit argument, even when not explicitly provided.
- nin: number of input ndarrays.
- nout: number of output ndarrays.
Examples
var setProps = require( '@stdlib/ndarray-base-meta-data-props' );
// Define ndarray function meta data:
var meta = {
'nargs': 2,
'nin': 1,
'nout': 1
};
// Define the list of ndarray data types:
var types = [
'float64', 'float64',
'float32', 'float32',
'generic', 'generic'
];
// Define an object/function on which to set the properties:
var obj = {};
// Set the properties:
setProps( meta, types, obj );
// Retrieve ndarray function data...
var nargs = obj.nargs;
// returns 2
var nin = obj.nin;
// returns 1
var nout = obj.nout;
// returns 1
var sigs = obj.types;
// returns [...]Notice
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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.