time-to-botec/squiggle/node_modules/@stdlib/math/strided/special/deg2rad/README.md

deg2rad

Convert each element in a strided array from degrees to radians.

Usage

var deg2rad = require( '@stdlib/math/strided/special/deg2rad' );

deg2rad( N, x, strideX, y, strideY )

Converts each element in a strided array x from degrees to radians and assigns the results to elements in a strided array y.

var Float64Array = require( '@stdlib/array/float64' );

var x = new Float64Array( [ 0.0, 30.0, 45.0, 60.0, 90.0 ] );

// Perform operation in-place:
deg2rad( x.length, x, 1, x, 1 );
// x => <Float64Array>[ 0.0, ~0.524, ~0.785, ~1.047, ~1.571 ]

The function accepts the following arguments:

• N: number of indexed elements.
• x: input array-like object.
• strideX: index increment for x.
• y: output array-like object.
• strideY: index increment for y.

The N and stride parameters determine which elements in x and y are accessed at runtime. For example, to index every other value in x and the first N elements of y in reverse order,

var Float64Array = require( '@stdlib/array/float64' );

var x = new Float64Array( [ 0.0, 30.0, 45.0, 60.0, 90.0, 120.0 ] );
var y = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

deg2rad( 3, x, 2, y, -1 );
// y => <Float64Array>[ ~1.571, ~0.785, 0.0, 0.0, 0.0, 0.0 ]

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float64Array = require( '@stdlib/array/float64' );

// Initial arrays...
var x0 = new Float64Array( [ 0.0, 30.0, 45.0, 60.0, 90.0, 120.0 ] );
var y0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

// Create offset views...
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element

deg2rad( 3, x1, -2, y1, 1 );
// y0 => <Float64Array>[ 0.0, 0.0, 0.0, ~2.094, ~1.047, ~0.524 ]

deg2rad.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )

Converts each element in a strided array x from degrees to radians and assigns the results to elements in a strided array y using alternative indexing semantics.

var Float64Array = require( '@stdlib/array/float64' );

var x = new Float64Array( [ 0.0, 30.0, 45.0, 60.0, 90.0 ] );
var y = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );

deg2rad.ndarray( x.length, x, 1, 0, y, 1, 0 );
// y => <Float64Array>[ 0.0, ~0.524, ~0.785, ~1.047, ~1.571 ]

The function accepts the following additional arguments:

• offsetX: starting index for x.
• offsetY: starting index for y.

While typed array views mandate a view offset based on the underlying buffer, the offsetX and offsetY parameters support indexing semantics based on starting indices. For example, to index every other value in x starting from the second value and to index the last N elements in y,

var Float64Array = require( '@stdlib/array/float64' );

var x = new Float64Array( [ 0.0, 30.0, 45.0, 60.0, 90.0, 120.0 ] );
var y = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

deg2rad.ndarray( 3, x, 2, 1, y, -1, y.length-1 );
// y => <Float64Array>[ 0.0, 0.0, 0.0, ~2.094, ~1.047, ~0.524 ]

Examples

var uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarray = require( '@stdlib/array/filled' );
var dtypes = require( '@stdlib/array/dtypes' );
var gfillBy = require( '@stdlib/blas/ext/base/gfill-by' );
var deg2rad = require( '@stdlib/math/strided/special/deg2rad' );

var dt;
var x;
var y;
var i;

dt = dtypes();
for ( i = 0; i < dt.length; i++ ) {
    x = filledarray( 0.0, 10, dt[ i ] );
    gfillBy( x.length, x, 1, uniform( -180.0, 180.0 ) );
    console.log( x );

    y = filledarray( 0.0, x.length, 'generic' );
    console.log( y );

    deg2rad.ndarray( x.length, x, 1, 0, y, -1, y.length-1 );
    console.log( y );
    console.log( '' );
}