time-to-botec

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

index.js (1442B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2021 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 * Broadcast an ndarray to a specified shape.
     23 *
     24 * @module @stdlib/ndarray/base/broadcast-array
     25 *
     26 * @example
     27 * var array = require( '@stdlib/ndarray/array' );
     28 * var broadcastArray = require( '@stdlib/ndarray/base/broadcast-array' );
     29 *
     30 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
     31 * // returns <ndarray>
     32 *
     33 * var shx = x.shape;
     34 * // returns [ 2, 2 ]
     35 *
     36 * var y = broadcastArray( x, [ 3, 2, 2 ] );
     37 * // returns <ndarray>
     38 *
     39 * var shy = y.shape;
     40 * // returns [ 3, 2, 2 ]
     41 *
     42 * var v = y.get( 0, 0, 0 );
     43 * // returns 1
     44 *
     45 * v = y.get( 0, 0, 1 );
     46 * // returns 2
     47 *
     48 * v = y.get( 1, 0, 0 );
     49 * // returns 1
     50 *
     51 * v = y.get( 1, 1, 0 );
     52 * // returns 3
     53 *
     54 * v = y.get( 2, 0, 0 );
     55 * // returns 1
     56 *
     57 * v = y.get( 2, 1, 1 );
     58 * // returns 4
     59 */
     60 
     61 // MODULES //
     62 
     63 var main = require( './main.js' );
     64 
     65 
     66 // EXPORTS //
     67 
     68 module.exports = main;