/** * @license Apache-2.0 * * Copyright (c) 2025 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'; /** * Test whether an ndarray contains a specified value along one or more dimensions. * * @module @stdlib/ndarray/includes * * @example * var Float64Array = require( '@stdlib/array/float64' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var includes = require( '@stdlib/ndarray/includes' ); * * // Create a data buffer: * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); * * // Define the shape of the input array: * var sh = [ 3, 1, 2 ]; * * // Define the array strides: * var sx = [ 4, 4, 1 ]; * * // Define the index offset: * var ox = 1; * * // Create an input ndarray: * var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' ); * * // Perform reduction: * var out = includes( x, 6.0 ); * // returns * * var v = out.get(); * // returns true * * @example * var Float64Array = require( '@stdlib/array/float64' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var empty = require( '@stdlib/ndarray/empty' ); * var includes = require( '@stdlib/ndarray/includes' ); * * // Create a data buffer: * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); * * // Define the shape of the input array: * var shape = [ 3, 1, 2 ]; * * // Define the array strides: * var sx = [ 4, 4, 1 ]; * * // Define the index offset: * var ox = 1; * * // Create an input ndarray: * var x = new ndarray( 'float64', xbuf, shape, sx, ox, 'row-major' ); * * // Create an output ndarray: * var y = empty( [], { * 'dtype': 'bool' * }); * * // Perform reduction: * var out = includes.assign( x, 6.0, y ); * // returns * * var v = out.get(); * // returns true */ // MODULES // var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); var main = require( './main.js' ); var assign = require( './assign.js' ); // MAIN // setReadOnly( main, 'assign', assign ); // EXPORTS // module.exports = main; // exports: { "assign": "main.assign" }