<!--

@license Apache-2.0

Copyright (c) 2026 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.

-->

# assignScalar

> Assign a scalar value to every element of an output [ndarray][@stdlib/ndarray/base/ctor].

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var assignScalar = require( '@stdlib/ndarray/base/assign-scalar' );
```

#### assignScalar( arrays )

Assigns a scalar value to every element of an output [ndarray][@stdlib/ndarray/base/ctor].

<!-- eslint-disable max-len -->

```javascript
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var Float64Array = require( '@stdlib/array/float64' );

// Create a zero-dimensional ndarray containing the scalar value:
var x = scalar2ndarray( 5.0, {
    'dtype': 'float64'
});

// Create a data buffer:
var ybuf = new Float64Array( 6 );

// Define the shape of the output array:
var shape = [ 3, 1, 2 ];

// Define the array strides:
var sy = [ 2, 2, 1 ];

// Define the index offset:
var oy = 0;

// Create the output ndarray-like object:
var y = {
    'dtype': 'float64',
    'data': ybuf,
    'shape': shape,
    'strides': sy,
    'offset': oy,
    'order': 'row-major'
};

// Assign the scalar value:
assignScalar( [ x, y ] );

console.log( y.data );
// => <Float64Array>[ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ]
```

The function accepts the following arguments:

-   **arrays**: array-like object containing a zero-dimensional input [ndarray][@stdlib/ndarray/base/ctor] and an output [ndarray][@stdlib/ndarray/base/ctor].

Each provided [ndarray][@stdlib/ndarray/base/ctor] should be an object with the following properties:

-   **dtype**: data type.
-   **data**: data buffer.
-   **shape**: dimensions.
-   **strides**: stride lengths.
-   **offset**: index offset.
-   **order**: specifies whether an ndarray is row-major (C-style) or column-major (Fortran-style).

</section>

<!-- /.usage -->

<section class="notes">

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var filledarray = require( '@stdlib/array/filled' );
var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
var assignScalar = require( '@stdlib/ndarray/base/assign-scalar' );

var x = scalar2ndarray( 10.0, {
    'dtype': 'generic'
});
console.log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );

var y = {
    'dtype': 'generic',
    'data': filledarray( 0, 10, 'generic' ),
    'shape': [ 5, 2 ],
    'strides': [ 2, 1 ],
    'offset': 0,
    'order': 'row-major'
};
console.log( ndarray2array( y.data, y.shape, y.strides, y.offset, y.order ) );

assignScalar( [ x, y ] );
console.log( ndarray2array( y.data, y.shape, y.strides, y.offset, y.order ) );
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[@stdlib/ndarray/base/ctor]: https://github.com/stdlib-js/ndarray/tree/main/base/ctor

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
