index.js (7210B)
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 assert 41 * @memberof ns 42 * @readonly 43 * @type {Namespace} 44 * @see {@link module:@stdlib/ndarray/base/assert} 45 */ 46 setReadOnly( ns, 'assert', require( './../../base/assert' ) ); 47 48 /** 49 * @name bind2vind 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/ndarray/base/bind2vind} 54 */ 55 setReadOnly( ns, 'bind2vind', require( './../../base/bind2vind' ) ); 56 57 /** 58 * @name broadcastArray 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/ndarray/base/broadcast-array} 63 */ 64 setReadOnly( ns, 'broadcastArray', require( './../../base/broadcast-array' ) ); 65 66 /** 67 * @name broadcastShapes 68 * @memberof ns 69 * @readonly 70 * @type {Function} 71 * @see {@link module:@stdlib/ndarray/base/broadcast-shapes} 72 */ 73 setReadOnly( ns, 'broadcastShapes', require( './../../base/broadcast-shapes' ) ); 74 75 /** 76 * @name buffer 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/ndarray/base/buffer} 81 */ 82 setReadOnly( ns, 'buffer', require( './../../base/buffer' ) ); 83 84 /** 85 * @name bufferCtors 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/ndarray/base/buffer-ctors} 90 */ 91 setReadOnly( ns, 'bufferCtors', require( './../../base/buffer-ctors' ) ); 92 93 /** 94 * @name bufferDataType 95 * @memberof ns 96 * @readonly 97 * @type {Function} 98 * @see {@link module:@stdlib/ndarray/base/buffer-dtype} 99 */ 100 setReadOnly( ns, 'bufferDataType', require( './../../base/buffer-dtype' ) ); 101 102 /** 103 * @name bufferDataTypeEnum 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/ndarray/base/buffer-dtype-enum} 108 */ 109 setReadOnly( ns, 'bufferDataTypeEnum', require( './../../base/buffer-dtype-enum' ) ); 110 111 /** 112 * @name bytesPerElement 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/ndarray/base/bytes-per-element} 117 */ 118 setReadOnly( ns, 'bytesPerElement', require( './../../base/bytes-per-element' ) ); 119 120 /** 121 * @name clampIndex 122 * @memberof ns 123 * @readonly 124 * @type {Function} 125 * @see {@link module:@stdlib/ndarray/base/clamp-index} 126 */ 127 setReadOnly( ns, 'clampIndex', require( './../../base/clamp-index' ) ); 128 129 /** 130 * @name ndarray 131 * @memberof ns 132 * @readonly 133 * @type {Function} 134 * @see {@link module:@stdlib/ndarray/base/ctor} 135 */ 136 setReadOnly( ns, 'ndarray', require( './../../base/ctor' ) ); 137 138 /** 139 * @name dtypeChar 140 * @memberof ns 141 * @readonly 142 * @type {Function} 143 * @see {@link module:@stdlib/ndarray/base/dtype-char} 144 */ 145 setReadOnly( ns, 'dtypeChar', require( './../../base/dtype-char' ) ); 146 147 /** 148 * @name dtypes2signatures 149 * @memberof ns 150 * @readonly 151 * @type {Function} 152 * @see {@link module:@stdlib/ndarray/base/dtypes2signatures} 153 */ 154 setReadOnly( ns, 'dtypes2signatures', require( './../../base/dtypes2signatures' ) ); 155 156 /** 157 * @name ind 158 * @memberof ns 159 * @readonly 160 * @type {Function} 161 * @see {@link module:@stdlib/ndarray/base/ind} 162 */ 163 setReadOnly( ns, 'ind', require( './../../base/ind' ) ); 164 165 /** 166 * @name ind2sub 167 * @memberof ns 168 * @readonly 169 * @type {Function} 170 * @see {@link module:@stdlib/ndarray/base/ind2sub} 171 */ 172 setReadOnly( ns, 'ind2sub', require( './../../base/ind2sub' ) ); 173 174 /** 175 * @name iterationOrder 176 * @memberof ns 177 * @readonly 178 * @type {Function} 179 * @see {@link module:@stdlib/ndarray/base/iteration-order} 180 */ 181 setReadOnly( ns, 'iterationOrder', require( './../../base/iteration-order' ) ); 182 183 /** 184 * @name maxViewBufferIndex 185 * @memberof ns 186 * @readonly 187 * @type {Function} 188 * @see {@link module:@stdlib/ndarray/base/max-view-buffer-index} 189 */ 190 setReadOnly( ns, 'maxViewBufferIndex', require( './../../base/max-view-buffer-index' ) ); 191 192 /** 193 * @name minViewBufferIndex 194 * @memberof ns 195 * @readonly 196 * @type {Function} 197 * @see {@link module:@stdlib/ndarray/base/min-view-buffer-index} 198 */ 199 setReadOnly( ns, 'minViewBufferIndex', require( './../../base/min-view-buffer-index' ) ); 200 201 /** 202 * @name minmaxViewBufferIndex 203 * @memberof ns 204 * @readonly 205 * @type {Function} 206 * @see {@link module:@stdlib/ndarray/base/minmax-view-buffer-index} 207 */ 208 setReadOnly( ns, 'minmaxViewBufferIndex', require( './../../base/minmax-view-buffer-index' ) ); 209 210 /** 211 * @name nonsingletonDimensions 212 * @memberof ns 213 * @readonly 214 * @type {Function} 215 * @see {@link module:@stdlib/ndarray/base/nonsingleton-dimensions} 216 */ 217 setReadOnly( ns, 'nonsingletonDimensions', require( './../../base/nonsingleton-dimensions' ) ); 218 219 /** 220 * @name numel 221 * @memberof ns 222 * @readonly 223 * @type {Function} 224 * @see {@link module:@stdlib/ndarray/base/numel} 225 */ 226 setReadOnly( ns, 'numel', require( './../../base/numel' ) ); 227 228 /** 229 * @name serializeMetaData 230 * @memberof ns 231 * @readonly 232 * @type {Function} 233 * @see {@link module:@stdlib/ndarray/base/serialize-meta-data} 234 */ 235 setReadOnly( ns, 'serializeMetaData', require( './../../base/serialize-meta-data' ) ); 236 237 /** 238 * @name shape2strides 239 * @memberof ns 240 * @readonly 241 * @type {Function} 242 * @see {@link module:@stdlib/ndarray/base/shape2strides} 243 */ 244 setReadOnly( ns, 'shape2strides', require( './../../base/shape2strides' ) ); 245 246 /** 247 * @name singletonDimensions 248 * @memberof ns 249 * @readonly 250 * @type {Function} 251 * @see {@link module:@stdlib/ndarray/base/singleton-dimensions} 252 */ 253 setReadOnly( ns, 'singletonDimensions', require( './../../base/singleton-dimensions' ) ); 254 255 /** 256 * @name strides2offset 257 * @memberof ns 258 * @readonly 259 * @type {Function} 260 * @see {@link module:@stdlib/ndarray/base/strides2offset} 261 */ 262 setReadOnly( ns, 'strides2offset', require( './../../base/strides2offset' ) ); 263 264 /** 265 * @name strides2order 266 * @memberof ns 267 * @readonly 268 * @type {Function} 269 * @see {@link module:@stdlib/ndarray/base/strides2order} 270 */ 271 setReadOnly( ns, 'strides2order', require( './../../base/strides2order' ) ); 272 273 /** 274 * @name sub2ind 275 * @memberof ns 276 * @readonly 277 * @type {Function} 278 * @see {@link module:@stdlib/ndarray/base/sub2ind} 279 */ 280 setReadOnly( ns, 'sub2ind', require( './../../base/sub2ind' ) ); 281 282 /** 283 * @name ndarray2array 284 * @memberof ns 285 * @readonly 286 * @type {Function} 287 * @see {@link module:@stdlib/ndarray/base/to-array} 288 */ 289 setReadOnly( ns, 'ndarray2array', require( './../../base/to-array' ) ); 290 291 /** 292 * @name vind2bind 293 * @memberof ns 294 * @readonly 295 * @type {Function} 296 * @see {@link module:@stdlib/ndarray/base/vind2bind} 297 */ 298 setReadOnly( ns, 'vind2bind', require( './../../base/vind2bind' ) ); 299 300 /** 301 * @name wrapIndex 302 * @memberof ns 303 * @readonly 304 * @type {Function} 305 * @see {@link module:@stdlib/ndarray/base/wrap-index} 306 */ 307 setReadOnly( ns, 'wrapIndex', require( './../../base/wrap-index' ) ); 308 309 310 // EXPORTS // 311 312 module.exports = ns;