Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/ndarray-base-assert

Base ndarray assertion utilities.

https://github.com/stdlib-js/ndarray-base-assert

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.0%) to scientific vocabulary

Keywords

array assert assertion base buffer data is javascript matrix multidimensional ndarray node node-js nodejs stdlib structures types valid validate vector
Last synced: 6 months ago · JSON representation ·

Repository

Base ndarray assertion utilities.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
array assert assertion base buffer data is javascript matrix multidimensional ndarray node node-js nodejs stdlib structures types valid validate vector
Created over 4 years 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!

Assert

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

Base ndarray assertion utilities.

## Installation ```bash npm install @stdlib/ndarray-base-assert ``` 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 ns = require( '@stdlib/ndarray-base-assert' ); ``` #### ns Base ndarray assertion utilities. ```javascript var o = ns; // returns {...} ```
- [`hasEqualShape( x, y )`][@stdlib/ndarray/base/assert/has-equal-shape]: test if two ndarrays have the same shape. - [`isAllowedDataTypeCast( from, to, casting )`][@stdlib/ndarray/base/assert/is-allowed-data-type-cast]: determine whether an ndarray data type can be cast to another ndarray data type according to a specified casting mode. - [`isBooleanDataType( value )`][@stdlib/ndarray/base/assert/is-boolean-data-type]: test if an input value is a supported ndarray boolean data type. - [`isBooleanIndexDataType( value )`][@stdlib/ndarray/base/assert/is-boolean-index-data-type]: test if an input value is a supported ndarray boolean index data type. - [`isBufferLengthCompatibleShape( len, shape )`][@stdlib/ndarray/base/assert/is-buffer-length-compatible-shape]: determine if a buffer length is compatible with an array shape. - [`isBufferLengthCompatible( len, shape, strides, offset )`][@stdlib/ndarray/base/assert/is-buffer-length-compatible]: determine if a buffer length is compatible with ndarray meta data. - [`isCastingMode( value )`][@stdlib/ndarray/base/assert/is-casting-mode]: test if an input value is a supported ndarray casting mode. - [`isColumnMajorContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-column-major-contiguous]: determine if an array is column-major contiguous. - [`isColumnMajorString( value )`][@stdlib/ndarray/base/assert/is-column-major-string]: test whether an input value is the string representing column-major order. - [`isColumnMajor( strides )`][@stdlib/ndarray/base/assert/is-column-major]: given a stride array, determine whether an array is column-major. - [`isComplexFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-complex-floating-point-data-type]: test if an input value is a supported ndarray complex-valued floating-point data type. - [`isContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-contiguous]: determine if an array is contiguous. - [`isDataType( value )`][@stdlib/ndarray/base/assert/is-data-type]: test if an input value is a supported ndarray data type. - [`isFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-floating-point-data-type]: test if an input value is a supported ndarray floating-point data type. - [`isIndexDataType( value )`][@stdlib/ndarray/base/assert/is-index-data-type]: test if an input value is a supported ndarray index data type. - [`isIndexMode( value )`][@stdlib/ndarray/base/assert/is-index-mode]: test if an input value is a supported ndarray index mode. - [`isInputCastingPolicy( value )`][@stdlib/ndarray/base/assert/is-input-casting-policy]: test if an input value is a supported input ndarray casting policy. - [`isIntegerDataType( value )`][@stdlib/ndarray/base/assert/is-integer-data-type]: test if an input value is a supported ndarray integer data type. - [`isIntegerIndexDataType( value )`][@stdlib/ndarray/base/assert/is-integer-index-data-type]: test if an input value is a supported ndarray integer index data type. - [`isMaskIndexDataType( value )`][@stdlib/ndarray/base/assert/is-mask-index-data-type]: test if an input value is a supported ndarray mask index data type. - [`isMostlySafeDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast]: determine whether an ndarray data type can be safely cast or, for floating-point data types, downcast to another ndarray data type. - [`isNumericDataType( value )`][@stdlib/ndarray/base/assert/is-numeric-data-type]: test if an input value is a supported ndarray numeric data type. - [`isOrder( value )`][@stdlib/ndarray/base/assert/is-order]: test if an input value is an ndarray order. - [`isOutputDataTypePolicy( value )`][@stdlib/ndarray/base/assert/is-output-data-type-policy]: test if an input value is a supported ndarray output data type policy. - [`isReadOnly( arr )`][@stdlib/ndarray/base/assert/is-read-only]: test if an ndarray is **read-only**. - [`isRealDataType( value )`][@stdlib/ndarray/base/assert/is-real-data-type]: test if an input value is a supported ndarray real-valued data type. - [`isRealFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-real-floating-point-data-type]: test if an input value is a supported ndarray real-valued floating-point data type. - [`isRowMajorContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-row-major-contiguous]: determine if an array is row-major contiguous. - [`isRowMajorString( value )`][@stdlib/ndarray/base/assert/is-row-major-string]: test whether an input value is the string representing row-major order. - [`isRowMajor( strides )`][@stdlib/ndarray/base/assert/is-row-major]: given a stride array, determine whether an array is row-major. - [`isSafeDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-safe-data-type-cast]: determine whether an ndarray data type can be safely cast to another ndarray data type. - [`isSameKindDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-same-kind-data-type-cast]: determine whether an ndarray data type can be safely cast to, or is of the same "kind" as, another ndarray data type. - [`isScalarMostlySafeCompatible( value, dtype )`][@stdlib/ndarray/base/assert/is-scalar-mostly-safe-compatible]: determine whether a scalar value can be safely cast or, for floating-point data types, downcast to specified ndarray data type. - [`isSignedIntegerDataType( value )`][@stdlib/ndarray/base/assert/is-signed-integer-data-type]: test if an input value is a supported ndarray signed integer data type. - [`isSingleSegmentCompatible( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-single-segment-compatible]: determine if an array is compatible with a single memory segment. - [`isStructDataType( value )`][@stdlib/ndarray/base/assert/is-struct-data-type]: test if an input value is a supported ndarray struct data type. - [`isUnsignedIntegerDataType( value )`][@stdlib/ndarray/base/assert/is-unsigned-integer-data-type]: test if an input value is a supported ndarray unsigned integer data type.
## Examples ```javascript var objectKeys = require( '@stdlib/utils-keys' ); var ns = require( '@stdlib/ndarray-base-assert' ); console.log( objectKeys( ns ) ); ```
* * * ## 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: 77
Last Year
  • Push event: 77

Committers

Last synced: about 2 years ago

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

Issues and Pull Requests

Last synced: over 1 year 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

Packages

  • Total packages: 1
  • Total downloads:
    • npm 30 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 1
  • Total versions: 11
  • Total maintainers: 4
npmjs.org: @stdlib/ndarray-base-assert

Base ndarray assertion utilities.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.3.0
    published over 1 year ago
  • Versions: 11
  • Dependent Packages: 3
  • Dependent Repositories: 1
  • Downloads: 30 Last month
Rankings
Dependent packages count: 5.9%
Dependent repos count: 10.4%
Average: 13.0%
Stargazers count: 14.6%
Forks count: 15.4%
Downloads: 18.7%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 6 months ago

Dependencies

package.json npm
  • @stdlib/assert-is-boolean ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/math-base-special-abs ^0.0.x development
  • @stdlib/math-base-special-floor ^0.0.x development
  • @stdlib/ndarray-array ^0.0.x development
  • @stdlib/ndarray-base-iteration-order ^0.0.x development
  • @stdlib/ndarray-base-minmax-view-buffer-index ^0.0.x development
  • @stdlib/ndarray-base-numel ^0.0.x development
  • @stdlib/ndarray-base-shape2strides ^0.0.x development
  • @stdlib/ndarray-base-strides2offset ^0.0.x development
  • @stdlib/ndarray-casting-modes ^0.0.x development
  • @stdlib/ndarray-dtypes ^0.0.x development
  • @stdlib/ndarray-index-modes ^0.0.x development
  • @stdlib/ndarray-orders ^0.0.x development
  • @stdlib/ndarray-safe-casts ^0.0.x development
  • @stdlib/ndarray-same-kind-casts ^0.0.x development
  • @stdlib/random-base-discrete-uniform ^0.0.x development
  • @stdlib/random-base-randu ^0.0.x development
  • @stdlib/utils-keys ^0.0.x development
  • istanbul ^0.4.1 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/ndarray-base-assert-is-allowed-data-type-cast ^0.0.x
  • @stdlib/ndarray-base-assert-is-buffer-length-compatible ^0.0.x
  • @stdlib/ndarray-base-assert-is-buffer-length-compatible-shape ^0.0.x
  • @stdlib/ndarray-base-assert-is-casting-mode ^0.0.x
  • @stdlib/ndarray-base-assert-is-column-major ^0.0.x
  • @stdlib/ndarray-base-assert-is-column-major-contiguous ^0.0.x
  • @stdlib/ndarray-base-assert-is-contiguous ^0.0.x
  • @stdlib/ndarray-base-assert-is-data-type ^0.0.x
  • @stdlib/ndarray-base-assert-is-index-mode ^0.0.x
  • @stdlib/ndarray-base-assert-is-order ^0.0.x
  • @stdlib/ndarray-base-assert-is-read-only ^0.0.x
  • @stdlib/ndarray-base-assert-is-row-major ^0.0.x
  • @stdlib/ndarray-base-assert-is-row-major-contiguous ^0.0.x
  • @stdlib/ndarray-base-assert-is-safe-data-type-cast ^0.0.x
  • @stdlib/ndarray-base-assert-is-same-kind-data-type-cast ^0.0.x
  • @stdlib/ndarray-base-assert-is-single-segment-compatible ^0.0.x
  • @stdlib/utils-define-read-only-property ^0.0.x
.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite