index.js (4694B)
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 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name. 23 */ 24 25 // MODULES // 26 27 var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); 28 29 30 // MAIN // 31 32 /** 33 * Top-level namespace. 34 * 35 * @namespace ns 36 */ 37 var ns = {}; 38 39 /** 40 * @name isAllowedDataTypeCast 41 * @memberof ns 42 * @readonly 43 * @type {Function} 44 * @see {@link module:@stdlib/ndarray/base/assert/is-allowed-data-type-cast} 45 */ 46 setReadOnly( ns, 'isAllowedDataTypeCast', require( './../../../base/assert/is-allowed-data-type-cast' ) ); 47 48 /** 49 * @name isBufferLengthCompatible 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/ndarray/base/assert/is-buffer-length-compatible} 54 */ 55 setReadOnly( ns, 'isBufferLengthCompatible', require( './../../../base/assert/is-buffer-length-compatible' ) ); 56 57 /** 58 * @name isBufferLengthCompatibleShape 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/ndarray/base/assert/is-buffer-length-compatible-shape} 63 */ 64 setReadOnly( ns, 'isBufferLengthCompatibleShape', require( './../../../base/assert/is-buffer-length-compatible-shape' ) ); 65 66 /** 67 * @name isCastingMode 68 * @memberof ns 69 * @readonly 70 * @type {Function} 71 * @see {@link module:@stdlib/ndarray/base/assert/is-casting-mode} 72 */ 73 setReadOnly( ns, 'isCastingMode', require( './../../../base/assert/is-casting-mode' ) ); 74 75 /** 76 * @name isColumnMajor 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/ndarray/base/assert/is-column-major} 81 */ 82 setReadOnly( ns, 'isColumnMajor', require( './../../../base/assert/is-column-major' ) ); 83 84 /** 85 * @name isColumnMajorContiguous 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/ndarray/base/assert/is-column-major-contiguous} 90 */ 91 setReadOnly( ns, 'isColumnMajorContiguous', require( './../../../base/assert/is-column-major-contiguous' ) ); 92 93 /** 94 * @name isContiguous 95 * @memberof ns 96 * @readonly 97 * @type {Function} 98 * @see {@link module:@stdlib/ndarray/base/assert/is-contiguous} 99 */ 100 setReadOnly( ns, 'isContiguous', require( './../../../base/assert/is-contiguous' ) ); 101 102 /** 103 * @name isDataType 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/ndarray/base/assert/is-data-type} 108 */ 109 setReadOnly( ns, 'isDataType', require( './../../../base/assert/is-data-type' ) ); 110 111 /** 112 * @name isIndexMode 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/ndarray/base/assert/is-index-mode} 117 */ 118 setReadOnly( ns, 'isIndexMode', require( './../../../base/assert/is-index-mode' ) ); 119 120 /** 121 * @name isOrder 122 * @memberof ns 123 * @readonly 124 * @type {Function} 125 * @see {@link module:@stdlib/ndarray/base/assert/is-order} 126 */ 127 setReadOnly( ns, 'isOrder', require( './../../../base/assert/is-order' ) ); 128 129 /** 130 * @name isRowMajor 131 * @memberof ns 132 * @readonly 133 * @type {Function} 134 * @see {@link module:@stdlib/ndarray/base/assert/is-row-major} 135 */ 136 setReadOnly( ns, 'isRowMajor', require( './../../../base/assert/is-row-major' ) ); 137 138 /** 139 * @name isRowMajorContiguous 140 * @memberof ns 141 * @readonly 142 * @type {Function} 143 * @see {@link module:@stdlib/ndarray/base/assert/is-row-major-contiguous} 144 */ 145 setReadOnly( ns, 'isRowMajorContiguous', require( './../../../base/assert/is-row-major-contiguous' ) ); 146 147 /** 148 * @name isSafeDataTypeCast 149 * @memberof ns 150 * @readonly 151 * @type {Function} 152 * @see {@link module:@stdlib/ndarray/base/assert/is-safe-data-type-cast} 153 */ 154 setReadOnly( ns, 'isSafeDataTypeCast', require( './../../../base/assert/is-safe-data-type-cast' ) ); 155 156 /** 157 * @name isSameKindDataTypeCast 158 * @memberof ns 159 * @readonly 160 * @type {Function} 161 * @see {@link module:@stdlib/ndarray/base/assert/is-same-kind-data-type-cast} 162 */ 163 setReadOnly( ns, 'isSameKindDataTypeCast', require( './../../../base/assert/is-same-kind-data-type-cast' ) ); 164 165 /** 166 * @name isSingleSegmentCompatible 167 * @memberof ns 168 * @readonly 169 * @type {Function} 170 * @see {@link module:@stdlib/ndarray/base/assert/is-single-segment-compatible} 171 */ 172 setReadOnly( ns, 'isSingleSegmentCompatible', require( './../../../base/assert/is-single-segment-compatible' ) ); 173 174 175 // EXPORTS // 176 177 module.exports = ns;