time-to-botec

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

index.js (1536B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /**
     22 * Multidimensional array.
     23 *
     24 * @module @stdlib/ndarray/array
     25 *
     26 * @example
     27 * var array = require( '@stdlib/ndarray/array' );
     28 *
     29 * var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );
     30 * // returns <ndarray>
     31 *
     32 * var v = arr.get( 0, 0 );
     33 * // returns 1
     34 *
     35 * @example
     36 * var array = require( '@stdlib/ndarray/array' );
     37 *
     38 * var opts = {
     39 *     'dtype': 'generic',
     40 *     'flatten': false
     41 * };
     42 *
     43 * var arr = array( [ [ 1, 2 ], [ 3, 4 ] ], opts );
     44 * // returns <ndarray>
     45 *
     46 * var v = arr.get( 0 );
     47 * // returns [ 1, 2 ]
     48 *
     49 * @example
     50 * var Float64Array = require( '@stdlib/array/float64' );
     51 * var array = require( '@stdlib/ndarray/array' );
     52 *
     53 * var opts = {
     54 *     'shape': [ 2, 2 ]
     55 * };
     56 *
     57 * var arr = array( new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ), opts );
     58 * // returns <ndarray>
     59 *
     60 * var v = arr.get( 0, 0 );
     61 * // returns 1.0
     62 */
     63 
     64 // MODULES //
     65 
     66 var array = require( './main.js' );
     67 
     68 
     69 // EXPORTS //
     70 
     71 module.exports = array;