index.js (1472B)
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 * Return a boolean indicating if an array is compatible with a single memory segment. 23 * 24 * @module @stdlib/ndarray/base/assert/is-single-segment-compatible 25 * 26 * @example 27 * var isSingleSegmentCompatible = require( '@stdlib/ndarray/base/assert/is-single-segment-compatible' ); 28 * 29 * var shape = [ 2, 2 ]; 30 * var strides = [ 2, 1 ]; 31 * var offset = 0; 32 * 33 * var bool = isSingleSegmentCompatible( shape, strides, offset ); 34 * // returns true 35 * 36 * @example 37 * var isSingleSegmentCompatible = require( '@stdlib/ndarray/base/assert/is-single-segment-compatible' ); 38 * 39 * var shape = [ 10 ]; 40 * var strides = [ 3 ]; 41 * var offset = 0; 42 * 43 * var bool = isSingleSegmentCompatible( shape, strides, offset ); 44 * // returns false 45 */ 46 47 // MODULES // 48 49 var isSingleSegmentCompatible = require( './main.js' ); 50 51 52 // EXPORTS // 53 54 module.exports = isSingleSegmentCompatible;