Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Dec 4, 2023
1 parent aba7a96 commit 3260241
Show file tree
Hide file tree
Showing 20 changed files with 300 additions and 367 deletions.
39 changes: 10 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,31 +85,26 @@ The `N` and `stride` parameters determine which elements in `x` are accessed at

```javascript
var Float32Array = require( '@stdlib/array-float32' );
var floor = require( '@stdlib/math-base-special-floor' );

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

var N = floor( x.length / 2 );

sscal( N, 5.0, x, 2 );
sscal( 4, 5.0, x, 2 );
// x => <Float32Array>[ -10.0, 1.0, 15.0, -5.0, 20.0, 0.0, -5.0, -3.0 ]
```

Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.

```javascript
var Float32Array = require( '@stdlib/array-float32' );
var floor = require( '@stdlib/math-base-special-floor' );

// Initial array...
// Initial array:
var x0 = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );

// Create an offset view...
// Create an offset view:
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var N = 3;

// Scale every other value...
sscal( N, 5.0, x1, 2 );
// Scale every other value:
sscal( 3, 5.0, x1, 2 );
// x0 => <Float32Array>[ 1.0, -10.0, 3.0, -20.0, 5.0, -30.0 ]
```

Expand Down Expand Up @@ -165,27 +160,13 @@ sscal.ndarray( 3, 5.0, x, 1, x.length-3 );
<!-- eslint no-undef: "error" -->

```javascript
var round = require( '@stdlib/math-base-special-round' );
var randu = require( '@stdlib/random-base-randu' );
var Float32Array = require( '@stdlib/array-float32' );
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var sscal = require( '@stdlib/blas-base-sscal' );

var rand;
var sign;
var x;
var i;

x = new Float32Array( 10 );
for ( i = 0; i < x.length; i++ ) {
rand = round( randu()*100.0 );
sign = randu();
if ( sign < 0.5 ) {
sign = -1.0;
} else {
sign = 1.0;
}
x[ i ] = sign * rand;
}
var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

sscal( x.length, 5.0, x, 1 );
Expand Down
18 changes: 9 additions & 9 deletions benchmark/benchmark.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,20 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random-base-randu' );
var uniform = require( '@stdlib/random-array-uniform' );
var isnan = require( '@stdlib/math-base-assert-is-nan' );
var pow = require( '@stdlib/math-base-special-pow' );
var Float32Array = require( '@stdlib/array-float32' );
var pkg = require( './../package.json' ).name;
var sscal = require( './../lib/sscal.js' );


// VARIABLES //

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


// FUNCTIONS //

/**
Expand All @@ -39,13 +45,7 @@ var sscal = require( './../lib/sscal.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = new Float32Array( len );
for ( i = 0; i < len; i++ ) {
x[ i ] = ( randu()*20.0 ) - 10.0;
}
var x = uniform( len, -100.0, 100.0, options );
return benchmark;

function benchmark( b ) {
Expand Down
14 changes: 5 additions & 9 deletions benchmark/benchmark.native.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,9 @@

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random-base-randu' );
var uniform = require( '@stdlib/random-array-uniform' );
var isnan = require( '@stdlib/math-base-assert-is-nan' );
var pow = require( '@stdlib/math-base-special-pow' );
var Float32Array = require( '@stdlib/array-float32' );
var tryRequire = require( '@stdlib/utils-try-require' );
var pkg = require( './../package.json' ).name;

Expand All @@ -36,6 +35,9 @@ var sscal = tryRequire( resolve( __dirname, './../lib/sscal.native.js' ) );
var opts = {
'skip': ( sscal instanceof Error )
};
var options = {
'dtype': 'float32'
};


// FUNCTIONS //
Expand All @@ -48,13 +50,7 @@ var opts = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = new Float32Array( len );
for ( i = 0; i < len; i++ ) {
x[ i ] = ( randu()*10.0 ) - 20.0;
}
var x = uniform( len, -100.0, 100.0, options );
return benchmark;

function benchmark( b ) {
Expand Down
18 changes: 9 additions & 9 deletions benchmark/benchmark.ndarray.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,20 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random-base-randu' );
var uniform = require( '@stdlib/random-array-uniform' );
var isnan = require( '@stdlib/math-base-assert-is-nan' );
var pow = require( '@stdlib/math-base-special-pow' );
var Float32Array = require( '@stdlib/array-float32' );
var pkg = require( './../package.json' ).name;
var sscal = require( './../lib/ndarray.js' );


// VARIABLES //

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


// FUNCTIONS //

/**
Expand All @@ -39,13 +45,7 @@ var sscal = require( './../lib/ndarray.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = new Float32Array( len );
for ( i = 0; i < len; i++ ) {
x[ i ] = ( randu()*20.0 ) - 10.0;
}
var x = uniform( len, -100.0, 100.0, options );
return benchmark;

function benchmark( b ) {
Expand Down
14 changes: 5 additions & 9 deletions benchmark/benchmark.ndarray.native.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,9 @@

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random-base-randu' );
var uniform = require( '@stdlib/random-array-uniform' );
var isnan = require( '@stdlib/math-base-assert-is-nan' );
var pow = require( '@stdlib/math-base-special-pow' );
var Float32Array = require( '@stdlib/array-float32' );
var tryRequire = require( '@stdlib/utils-try-require' );
var pkg = require( './../package.json' ).name;

Expand All @@ -36,6 +35,9 @@ var sscal = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
var opts = {
'skip': ( sscal instanceof Error )
};
var options = {
'dtype': 'float32'
};


// FUNCTIONS //
Expand All @@ -48,13 +50,7 @@ var opts = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = new Float32Array( len );
for ( i = 0; i < len; i++ ) {
x[ i ] = ( randu()*20.0 ) - 10.0;
}
var x = uniform( len, -100.0, 100.0, options );
return benchmark;

function benchmark( b ) {
Expand Down
22 changes: 6 additions & 16 deletions docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,29 +34,23 @@
--------
// Standard Usage:
> var x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
> var alpha = 5.0;
> {{alias}}( x.length, alpha, x, 1 )
> {{alias}}( x.length, 5.0, x, 1 )
<Float32Array>[ -10.0, 5.0, 15.0, -25.0, 20.0, -5.0, -15.0 ]

// Using `N` and `stride` parameters:
> x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> alpha = 5.0;
> var stride = 2;
> {{alias}}( N, alpha, x, stride )
> {{alias}}( 3, 5.0, x, 2 )
<Float32Array>[ -10.0, 1.0, 15.0, -5.0, 20.0, -1.0, -3.0 ]

// Using view offsets:
> var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
> var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
> alpha = 5.0;
> stride = 2;
> {{alias}}( N, alpha, x1, stride )
> {{alias}}( 3, 5.0, x1, 2 )
<Float32Array>[ -10.0, 3.0, -20.0, 5.0, -30.0 ]
> x0
<Float32Array>[ 1.0, -10.0, 3.0, -20.0, 5.0, -30.0 ]


{{alias}}.ndarray( N, alpha, x, stride, offset )
Multiplies a single-precision floating-point vector `x` by a constant
`alpha` using alternative indexing semantics.
Expand Down Expand Up @@ -91,16 +85,12 @@
--------
// Standard Usage:
> var x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
> var alpha = 5.0;
> {{alias}}.ndarray( x.length, alpha, x, 1, 0 )
> {{alias}}.ndarray( x.length, 5.0, x, 1, 0 )
<Float32Array>[ -10.0, 5.0, 15.0, -25.0, 20.0, -5.0, -15.0 ]

// Using an index offset:
> x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> alpha = 5.0;
> var stride = 2;
> {{alias}}.ndarray( N, alpha, x, stride, 1 )
> {{alias}}.ndarray( 3, 5.0, x, 2, 1 )
<Float32Array>[ 1.0, -10.0, 3.0, -20.0, 5.0, -30.0 ]

See Also
Expand Down
6 changes: 3 additions & 3 deletions docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ interface Routine {
* @param alpha - constant
* @param x - input array
* @param stride - stride length
* @returns `y`
* @returns input array
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
Expand All @@ -49,7 +49,7 @@ interface Routine {
* @param x - input array
* @param stride - stride length
* @param offset - starting index
* @returns `x`
* @returns input array
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
Expand All @@ -69,7 +69,7 @@ interface Routine {
* @param alpha - constant
* @param x - input array
* @param stride - stride length
* @returns `x`
* @returns input array
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
Expand Down
6 changes: 3 additions & 3 deletions examples/c/example.c
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@

int main( void ) {
// Create a strided array:
float x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 };
float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };

// Specify the number of elements:
int N = 8;
const int N = 8;

// Specify a stride:
int strideX = 1;
const int strideX = 1;

// Scale the vector:
c_sscal( N, 5.0f, x, strideX );
Expand Down
24 changes: 5 additions & 19 deletions examples/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,13 @@

'use strict';

var round = require( '@stdlib/math-base-special-round' );
var randu = require( '@stdlib/random-base-randu' );
var Float32Array = require( '@stdlib/array-float32' );
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var sscal = require( './../lib' );

var rand;
var sign;
var x;
var i;

x = new Float32Array( 10 );
for ( i = 0; i < x.length; i++ ) {
rand = round( randu()*100.0 );
sign = randu();
if ( sign < 0.5 ) {
sign = -1.0;
} else {
sign = 1.0;
}
x[ i ] = sign * rand;
}
var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

sscal( x.length, 5.0, x, 1 );
Expand Down
2 changes: 1 addition & 1 deletion include.gypi
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@

# Source files:
'src_files': [
'<(src_dir)/addon.cpp',
'<(src_dir)/addon.c',
'<!@(node -e "var arr = require(\'@stdlib/utils-library-manifest\')(\'./manifest.json\',{\'os\':\'<(OS)\',\'blas\':\'<(blas)\'},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).src; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")',
],

Expand Down
7 changes: 4 additions & 3 deletions lib/ndarray.native.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@

// MODULES //

var Float32Array = require( '@stdlib/array-float32' );
var minViewBufferIndex = require( '@stdlib/strided-base-min-view-buffer-index' );
var offsetView = require( '@stdlib/strided-base-offset-view' );
var addon = require( './sscal.native.js' );


Expand All @@ -47,11 +48,11 @@ var addon = require( './sscal.native.js' );
*/
function sscal( N, alpha, x, stride, offset ) {
var view;
offset = minViewBufferIndex( N, stride, offset );
if ( stride < 0 ) {
stride *= -1;
offset -= (N-1) * stride;
}
view = new Float32Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offset), x.length-offset ); // eslint-disable-line max-len
view = offsetView( x, offset );
addon( N, alpha, view, stride );
return x;
}
Expand Down
Loading

0 comments on commit 3260241

Please sign in to comment.