time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (2485B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2018 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # isndarrayLike
     22 
     23 > Test if a value is [ndarray][@stdlib/ndarray/ctor]-like.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
     31 ```
     32 
     33 #### isndarrayLike( value )
     34 
     35 Tests if a value is [ndarray][@stdlib/ndarray/ctor]-like.
     36 
     37 ```javascript
     38 var ndarray = require( '@stdlib/ndarray/ctor' );
     39 
     40 var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
     41 var bool = isndarrayLike( arr );
     42 // returns true
     43 ```
     44 
     45 A value is [ndarray][@stdlib/ndarray/ctor]-like if a value is an `object` with the following properties:
     46 
     47 -   **dtype**: `string` specifying a data type.
     48 -   **data**: `object` pointing to an underlying data buffer.
     49 -   **shape**: array-like `object` containing dimensions.
     50 -   **strides**: array-like `object` containing stride lengths.
     51 -   **offset**: `number` specifying the index offset.
     52 -   **order**: `string` describing the memory layout.
     53 -   **ndims**: `number` specifying the number of dimensions.
     54 -   **length**: `number` specifying the total number of elements.
     55 -   **flags**: `object` containing meta data.
     56 -   **get**: `function` for retrieving elements.
     57 -   **set**: `function` for setting elements.
     58 
     59 </section>
     60 
     61 <!-- /.usage -->
     62 
     63 <section class="examples">
     64 
     65 ## Examples
     66 
     67 <!-- eslint no-undef: "error" -->
     68 
     69 ```javascript
     70 var ndarray = require( '@stdlib/ndarray/ctor' );
     71 var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
     72 
     73 var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
     74 var bool = isndarrayLike( arr );
     75 // returns true
     76 
     77 bool = isndarrayLike( [ 1, 2, 3, 4 ] );
     78 // returns false
     79 
     80 bool = isndarrayLike( {} );
     81 // returns false
     82 
     83 bool = isndarrayLike( null );
     84 // returns false
     85 ```
     86 
     87 </section>
     88 
     89 <!-- /.examples -->
     90 
     91 <section class="links">
     92 
     93 [@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor
     94 
     95 </section>
     96 
     97 <!-- /.links -->