Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 131 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
<!--

@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.

-->

# saxpb

> Multiply each element in a one-dimensional single-precision floating-point ndarray by a scalar constant and add a scalar constant to each result.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var saxpb = require( '@stdlib/blas/ext/base/ndarray/saxpb' );
```

#### saxpb( arrays )

Multiplies each element in a one-dimensional single-precision floating-point ndarray by a scalar constant and adds a scalar constant to each result.

```javascript
var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );

var x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );

var alpha = scalar2ndarray( 5.0, {
'dtype': 'float32'
});

var beta = scalar2ndarray( 3.0, {
'dtype': 'float32'
});

saxpb( [ x, alpha, beta ] );
// x => <ndarray>[ -7.0, 8.0, 18.0, -22.0, 23.0, 3.0, -2.0, -12.0 ]
```

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a zero-dimensional ndarray containing the scalar constant to multiply.
- a zero-dimensional ndarray containing the scalar constant to add.

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- The input ndarray is modified **in-place** (i.e., the input ndarray is **mutated**).

</section>

<!-- /.notes -->

<section class="examples">

## Examples

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

```javascript
var discreteUniform = require( '@stdlib/random/discrete-uniform' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
var saxpb = require( '@stdlib/blas/ext/base/ndarray/saxpb' );

var opts = {
'dtype': 'float32'
};

var x = discreteUniform( [ 10 ], -100, 100, opts );
console.log( ndarray2array( x ) );

var alpha = scalar2ndarray( 5.0, opts );
console.log( 'Alpha: %d', ndarraylike2scalar( alpha ) );

var beta = scalar2ndarray( 3.0, opts );
console.log( 'Beta: %d', ndarraylike2scalar( beta ) );

saxpb( [ x, alpha, beta ] );
console.log( ndarray2array( x ) );
```

</section>

<!-- /.examples -->

<!-- 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">

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
/**
* @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.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/uniform' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var pow = require( '@stdlib/math/base/special/pow' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var saxpb = require( './../lib' );


// VARIABLES //

var options = {
'dtype': 'float32'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - ndarray length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var alpha;
var beta;
var x;

x = uniform( [ len ], -100.0, 100.0, options );
alpha = scalar2ndarray( 5.0, options );
beta = scalar2ndarray( 3.0, options );
return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var out;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = saxpb( [ x, alpha, beta ] );
if ( typeof out !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( typeof out !== 'object' ) {
b.fail( 'should return an ndarray' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
35 changes: 35 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

{{alias}}( arrays )
Multiplies each element in a one-dimensional single-precision floating-point
ndarray by a scalar constant and adds a scalar constant to each result.

The input ndarray is modified *in-place* (i.e., the input ndarray is
*mutated*).

Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a zero-dimensional ndarray containing the scalar constant to multiply.
- a zero-dimensional ndarray containing the scalar constant to add.

Returns
-------
out: ndarray
Input ndarray.

Examples
--------
> var buf = [ -2.0, 1.0, 3.0, -5.0 ];
> var x = new {{alias:@stdlib/ndarray/vector/float32}}( buf );
> var opts = { 'dtype': 'float32' };
> var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 5.0, opts );
> var beta = {{alias:@stdlib/ndarray/from-scalar}}( 3.0, opts );
> {{alias}}( [ x, alpha, beta ] )
<ndarray>[ -7.0, 8.0, 18.0, -22.0 ]

See Also
--------

Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
* @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.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { float32ndarray, typedndarray } from '@stdlib/types/ndarray';

/**
* Multiplies each element in a one-dimensional single-precision floating-point ndarray by a scalar constant and adds a scalar constant to each result.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the scalar constant to multiply.
* - a zero-dimensional ndarray containing the scalar constant to add.
*
* @param arrays - array-like object containing ndarrays
* @returns input ndarray
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float32'
* });
*
* var beta = scalar2ndarray( 3.0, {
* 'dtype': 'float32'
* });
*
* var out = saxpb( [ x, alpha, beta ] );
* // returns <ndarray>[ -7.0, 8.0, 18.0, -22.0 ]
*/
declare function saxpb( arrays: [ float32ndarray, typedndarray<number>, typedndarray<number> ] ): float32ndarray;


// EXPORTS //

export = saxpb;
Loading