time-to-botec

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

enum.js (1424B)

      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 // MAIN //
     22 
     23 /**
     24 * Returns an object mapping supported orders to integer values for purposes of C inter-operation.
     25 *
     26 * ## Notes
     27 *
     28 * -   Downstream consumers of this mapping should **not** rely on specific integer values (e.g., `row-major == 1`). Instead, the object should be used in an opaque manner.
     29 * -   The main purpose of this function is JavaScript and C inter-operation of ndarray objects.
     30 *
     31 * @returns {Object} object mapping supported orders to integer values
     32 *
     33 * @example
     34 * var table = enumerated();
     35 * // returns <Object>
     36 */
     37 function enumerated() {
     38 	// NOTE: the following should match the C `orders.h` enumeration!!!!
     39 	return {
     40 		// Row-major (C-style):
     41 		'row-major': 1,
     42 
     43 		// Column-major (Fortran-style):
     44 		'column-major': 2
     45 	};
     46 }
     47 
     48 
     49 // EXPORTS //
     50 
     51 module.exports = enumerated;