50 lines
1.3 KiB
JavaScript
50 lines
1.3 KiB
JavaScript
|
/**
|
||
|
|
* @license Apache-2.0
|
||
|
|
*
|
||
|
|
* Copyright (c) 2021 The Stdlib Authors.
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
// MAIN //
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns an object mapping supported index modes to integer values for purposes of C inter-operation.
|
||
|
|
*
|
||
|
|
* ## Notes
|
||
|
|
*
|
||
|
|
* - Downstream consumers of this mapping should **not** rely on specific integer values (e.g., `throw == 1`). Instead, the object should be used in an opaque manner.
|
||
|
|
* - The main purpose of this function is JavaScript and C inter-operation of ndarray objects.
|
||
|
|
*
|
||
|
|
* @returns {Object} object mapping supported index modes to integer values
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var table = enumerated();
|
||
|
|
* // returns <Object>
|
||
|
|
*/
|
||
|
|
function enumerated() {
|
||
|
|
// NOTE: the following should match the C `index_modes.h` enumeration!!!!
|
||
|
|
return {
|
||
|
|
'throw': 1,
|
||
|
|
'clamp': 2,
|
||
|
|
'wrap': 3
|
||
|
|
};
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = enumerated;
|