Skip to content

README.md

Latest commit

 

History

History
292 lines (179 loc) · 7.61 KB

README.md

File metadata and controls

292 lines (179 loc) · 7.61 KB

coneTo

Fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by 1 starting from one.

Usage

var coneTo = require( '@stdlib/blas/ext/base/cone-to' );

coneTo( N, x, strideX )

Fills a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by 1 starting from one.

var Complex64Array = require( '@stdlib/array/complex64' );

var x = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

coneTo( x.length, x, 1 );
// x => <Complex64Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]

The function has the following parameters:

  • N: number of indexed elements.
  • x: input Complex64Array.
  • strideX: stride length.

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

var Complex64Array = require( '@stdlib/array/complex64' );

var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

coneTo( 3, x, 2 );
// x => <Complex64Array>[ 1.0, 0.0, 3.0, 4.0, 2.0, 0.0, 7.0, 8.0, 3.0, 0.0, 11.0, 12.0 ]

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

var Complex64Array = require( '@stdlib/array/complex64' );

// Initial array...
var x0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

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

// Fill every other element...
coneTo( 3, x1, 2 );
// x0 => <Complex64Array>[ 1.0, 2.0, 1.0, 0.0, 5.0, 6.0, 2.0, 0.0, 9.0, 10.0, 3.0, 0.0 ]

coneTo.ndarray( N, x, strideX, offsetX )

Fills a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by 1 starting from one using alternative indexing semantics.

var Complex64Array = require( '@stdlib/array/complex64' );

var x = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );

coneTo.ndarray( x.length, x, 1, 0 );
// x => <Complex64Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.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:

var Complex64Array = require( '@stdlib/array/complex64' );

var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

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

Notes

  • If N <= 0, both functions return x unchanged.

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var Complex64Array = require( '@stdlib/array/complex64' );
var coneTo = require( '@stdlib/blas/ext/base/cone-to' );

var xbuf = discreteUniform( 20, -100, 100, {
    'dtype': 'float32'
});
var x = new Complex64Array( xbuf.buffer );
console.log( x );

coneTo( x.length, x, 1 );
console.log( x );

C APIs

Usage

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

stdlib_strided_cone_to( N, *X, strideX )

Fills a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by 1 starting from one.

#include "stdlib/complex/float32/ctor.h"

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

stdlib_strided_cone_to( 4, (stdlib_complex64_t *)x, 1 );

The function accepts the following arguments:

  • N: [in] CBLAS_INT number of indexed elements.
  • X: [out] stdlib_complex64_t* input array.
  • strideX: [in] CBLAS_INT stride length.
void API_SUFFIX(stdlib_strided_cone_to)( const CBLAS_INT N, stdlib_complex64_t *X, const CBLAS_INT strideX );

stdlib_strided_cone_to_ndarray( N, *X, strideX, offsetX )

Fills a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by 1 starting from one using alternative indexing semantics.

#include "stdlib/complex/float32/ctor.h"

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

stdlib_strided_cone_to_ndarray( 4, (stdlib_complex64_t *)x, 1, 0 );

The function accepts the following arguments:

  • N: [in] CBLAS_INT number of indexed elements.
  • X: [out] stdlib_complex64_t* input array.
  • strideX: [in] CBLAS_INT stride length.
  • offsetX: [in] CBLAS_INT starting index.
void API_SUFFIX(stdlib_strided_cone_to_ndarray)( const CBLAS_INT N, stdlib_complex64_t *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );

Examples

#include "stdlib/blas/ext/base/cone_to.h"
#include "stdlib/complex/float32/ctor.h"
#include <stdio.h>

int main( void ) {
    // Create a strided array of interleaved real and imaginary components:
    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 = 4;

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

    // Fill the array:
    stdlib_strided_cone_to( N, (stdlib_complex64_t *)x, strideX );

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