Skip to content

stdlib-js/blas-ext-base-zreplicate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

zreplicate

NPM version Build Status Coverage Status

Replicate each element in a double-precision complex floating-point strided array a specified number of times.

Installation

npm install @stdlib/blas-ext-base-zreplicate

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

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

zreplicate( N, k, x, strideX, out, strideOut )

Replicates each element in a double-precision complex floating-point strided array a specified number of times.

var Complex128Array = require( '@stdlib/array-complex128' );

var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
var out = new Complex128Array( 4 );

zreplicate( x.length, 2, x, 1, out, 1 );
// out => <Complex128Array>[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]

The function has the following parameters:

  • N: number of indexed elements.
  • k: number of times to replicate each element.
  • x: input Complex128Array.
  • strideX: stride length for x.
  • out: output Complex128Array.
  • strideOut: stride length for out.

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

var Complex128Array = require( '@stdlib/array-complex128' );

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

zreplicate( 2, 2, x, 2, out, 1 );
// out => <Complex128Array>[ 1.0, 2.0, 1.0, 2.0, 5.0, 6.0, 5.0, 6.0 ]

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

var Complex128Array = require( '@stdlib/array-complex128' );

// Initial arrays...
var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var out0 = new Complex128Array( 3 );

// Create offset views...
var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var out1 = new Complex128Array( out0.buffer, out0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

zreplicate( 1, 2, x1, 2, out1, 1 );
// out0 => <Complex128Array>[ 0.0, 0.0, 3.0, 4.0, 3.0, 4.0 ]

zreplicate.ndarray( N, k, x, strideX, offsetX, out, strideOut, offsetOut )

Replicates each element in a double-precision complex floating-point strided array a specified number of times using alternative indexing semantics.

var Complex128Array = require( '@stdlib/array-complex128' );

var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
var out = new Complex128Array( 4 );

zreplicate.ndarray( x.length, 2, x, 1, 0, out, 1, 0 );
// out => <Complex128Array>[ 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]

The function has the following additional parameters:

  • offsetX: starting index for x.
  • offsetOut: starting index for out.

While typed array views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to replicate every element starting from the second element and to store in the last N*k elements of the output array starting from the last element:

var Complex128Array = require( '@stdlib/array-complex128' );

var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
var out = new Complex128Array( 2 );

zreplicate.ndarray( 1, 2, x, 1, 1, out, 1, 0 );
// out => <Complex128Array>[ 3.0, 4.0, 3.0, 4.0 ]

Notes

  • If N <= 0 or k <= 0, both functions return out unchanged.
  • Both functions assume that the output array supports N*k indexed elements.

Examples

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

var xbuf = discreteUniform( 10, -100, 100, {
    'dtype': 'float64'
});
var x = new Complex128Array( xbuf.buffer );
console.log( x );

var out = new Complex128Array( x.length * 5 );
console.log( out );

zreplicate( x.length, 5, x, 1, out, 1 );
console.log( out );

C APIs

Usage

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

stdlib_strided_zreplicate( N, k, *X, strideX, *Out, strideOut )

Replicates each element in a double-precision complex floating-point strided array a specified number of times.

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

const double x[] = { 1.0, 2.0, 3.0, 4.0 };
double out[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };

stdlib_strided_zreplicate( 2, 2, (stdlib_complex128_t *)x, 1, (stdlib_complex128_t *)out, 1 );

The function accepts the following arguments:

  • N: [in] CBLAS_INT number of indexed elements.
  • k: [in] CBLAS_INT number of times to replicate each element.
  • X: [in] stdlib_complex128_t* input array.
  • strideX: [in] CBLAS_INT stride length for X.
  • Out: [out] stdlib_complex128_t* output array.
  • strideOut: [in] CBLAS_INT stride length for Out.
void stdlib_strided_zreplicate( const CBLAS_INT N, const CBLAS_INT k, const stdlib_complex128_t *X, const CBLAS_INT strideX, stdlib_complex128_t *Out, const CBLAS_INT strideOut );

stdlib_strided_zreplicate_ndarray( N, k, *X, strideX, offsetX, *Out, strideOut, offsetOut )

Replicates each element in a double-precision complex floating-point strided array a specified number of times using alternative indexing semantics.

const double x[] = { 1.0, 2.0, 3.0, 4.0 };
double out[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };

stdlib_strided_zreplicate_ndarray( 2, 2, (stdlib_complex128_t *)x, 1, 0, (stdlib_complex128_t *)out, 1, 0 );

The function accepts the following arguments:

  • N: [in] CBLAS_INT number of indexed elements.
  • k: [in] CBLAS_INT number of times to replicate each element.
  • X: [in] stdlib_complex128_t* input array.
  • strideX: [in] CBLAS_INT stride length for X.
  • offsetX: [in] CBLAS_INT starting index for X.
  • Out: [out] stdlib_complex128_t* output array.
  • strideOut: [in] CBLAS_INT stride length for Out.
  • offsetOut: [in] CBLAS_INT starting index for Out.
void stdlib_strided_zreplicate_ndarray( const CBLAS_INT N, const CBLAS_INT k, const stdlib_complex128_t *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, stdlib_complex128_t *Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut );

Examples

#include "stdlib/blas/ext/base/zreplicate.h"
#include "stdlib/complex/float64/ctor.h"
#include <stdio.h>

int main( void ) {
    // Create strided arrays:
    const double x[] = { 1.0, 2.0, 3.0, 4.0 };
    double out[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 };

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

    // Specify the number of times to replicate each element:
    const int k = 2;

    // Specify strides:
    const int strideX = 1;
    const int strideOut = 1;

    // Replicate each element:
    stdlib_strided_zreplicate( N, k, (stdlib_complex128_t *)x, strideX, (stdlib_complex128_t *)out, strideOut );

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

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

No releases published

Packages

 
 
 

Contributors