README.md

scircshift

Circularly shift the elements of a single-precision floating-point strided array by a specified number of positions.

Usage

var scircshift = require( '@stdlib/blas/ext/base/scircshift' );

scircshift( N, k, x, strideX )

Circularly shifts the elements of a single-precision floating-point strided array by a specified number of positions.

var Float32Array = require( '@stdlib/array/float32' );

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

scircshift( x.length, 2, x, 1 );
// x => <Float32Array>[ 4.0, 5.0, 1.0, 2.0, 3.0 ]

The function has the following parameters:

• N: number of indexed elements.
• k: number of positions to shift.
• x: input Float32Array.
• strideX: stride length.

The N and stride parameters determine which elements in the strided array are accessed at runtime. For example, to circularly shift every other element:

var Float32Array = require( '@stdlib/array/float32' );

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

scircshift( 4, 1, x, 2 );
// x => <Float32Array>[ 4.0, 0.0, 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ]

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

var Float32Array = require( '@stdlib/array/float32' );

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

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

// Circularly shift elements in the view:
scircshift( 5, 2, x1, 1 );
// x0 => <Float32Array>[ 0.0, 4.0, 5.0, 1.0, 2.0, 3.0 ]

scircshift.ndarray( N, k, x, strideX, offsetX )

Circularly shifts the elements of a single-precision floating-point strided array by a specified number of positions using alternative indexing semantics.

var Float32Array = require( '@stdlib/array/float32' );

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

scircshift.ndarray( x.length, 2, x, 1, 0 );
// x => <Float32Array>[ 4.0, 5.0, 1.0, 2.0, 3.0 ]

The function has the following additional parameters:

• offsetX: starting index.

While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of the strided array:

var Float32Array = require( '@stdlib/array/float32' );

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

scircshift.ndarray( 3, 1, x, 1, x.length-3 );
// x => <Float32Array>[ 1.0, 2.0, 3.0, 6.0, 4.0, 5.0 ]

Notes

• If N <= 0, both functions return the strided array unchanged.
• If k is a multiple of N, both functions return the strided array unchanged.
• If k > 0, elements are shifted to the right.
• If k < 0, elements are shifted to the left.

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var scircshift = require( '@stdlib/blas/ext/base/scircshift' );

var x = discreteUniform( 10, -100, 100, {
    'dtype': 'float32'
});
console.log( x );

scircshift( x.length, 3, x, 1 );
console.log( x );

---

C APIs

Usage

#include "stdlib/blas/ext/base/scircshift.h"

stdlib_strided_scircshift( N, k, *X, strideX )

Circularly shifts the elements of a single-precision floating-point strided array by a specified number of positions.

float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f };

stdlib_strided_scircshift( 5, 2, x, 1 );

The function accepts the following arguments:

• N: [in] CBLAS_INT number of indexed elements.
• k: [in] CBLAS_INT number of positions to shift.
• X: [inout] float* input array.
• strideX: [in] CBLAS_INT stride length.

void stdlib_strided_scircshift( const CBLAS_INT N, const CBLAS_INT k, float *X, const CBLAS_INT strideX );

stdlib_strided_scircshift_ndarray( N, k, *X, strideX, offsetX )

Circularly shifts the elements of a single-precision floating-point strided array by a specified number of positions using alternative indexing semantics.

float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f };

stdlib_strided_scircshift_ndarray( 5, 2, x, 1, 0 );

The function accepts the following arguments:

• N: [in] CBLAS_INT number of indexed elements.
• k: [in] CBLAS_INT number of positions to shift.
• X: [inout] float* input array.
• strideX: [in] CBLAS_INT stride length.
• offsetX: [in] CBLAS_INT starting index.

void stdlib_strided_scircshift_ndarray( const CBLAS_INT N, const CBLAS_INT k, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );

Examples

#include "stdlib/blas/ext/base/scircshift.h"
#include <stdio.h>

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

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

    // Specify the shift amount:
    const int k = 3;

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

    // Perform the circular shift:
    stdlib_strided_scircshift( N, k, x, strideX );

    // Print the result:
    for ( int i = 0; i < 8; i++ ) {
        printf( "x[ %i ] = %f\n", i, x[ i ] );
    }
}