Skip to content
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!

clogspace

NPM version Build Status Coverage Status

Fill a one-dimensional single-precision complex floating-point ndarray with logarithmically spaced values over a specified interval.

Installation

npm install @stdlib/blas-ext-base-ndarray-clogspace

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 clogspace = require( '@stdlib/blas-ext-base-ndarray-clogspace' );

clogspace( arrays )

Fills a one-dimensional single-precision complex floating-point ndarray with logarithmically spaced values over a specified interval.

var Complex64Vector = require( '@stdlib/ndarray-vector-complex64' );
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );

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

var base = scalar2ndarray( 10.0, {
    'dtype': 'float32'
});

var strt = scalar2ndarray( new Complex64( 0.0, 0.0 ), {
    'dtype': 'complex64'
});

var stp = scalar2ndarray( new Complex64( 3.0, 0.0 ), {
    'dtype': 'complex64'
});

var endpoint = scalar2ndarray( true, {
    'dtype': 'bool'
});

var out = clogspace( [ x, base, strt, stp, endpoint ] );
// returns <ndarray>[ <Complex64>[ 1.0, 0.0 ], <Complex64>[ 10.0, 0.0 ], <Complex64>[ 100.0, 0.0 ], <Complex64>[ 1000.0, 0.0 ] ]

The function has the following parameters:

  • arrays: array-like object containing the following ndarrays:

    • a one-dimensional input ndarray.
    • a zero-dimensional ndarray specifying the base of the logarithmic scale.
    • a zero-dimensional ndarray specifying the exponent of the starting value, where the starting value is given by base^start.
    • a zero-dimensional ndarray specifying the exponent of the final value, where the final value is given by base^stop.
    • a zero-dimensional ndarray specifying whether to include the base^stop value when writing values to the input ndarray. If true, the input ndarray is filled with logarithmically spaced values over the closed interval [base^start, base^stop]. If false, the input ndarray is filled with logarithmically spaced values over the half-open interval [base^start, base^stop).

Notes

  • Let M be the number of generated values (which is either N or N+1 depending on whether endpoint is true or false, respectively). The complex increment between exponents is thus given by

    Δ = (stop-start)/(M-1)
    

    and the generated values are equal to base^(start+Δ*i) for i = 0, 1, ..., M-1, where exponentiation is performed in the complex sense.

  • When the number of generated values is greater than 1 and endpoint is true, the set of values written to a provided input ndarray is guaranteed to include the base^start and base^stop values. Beware, however, that values between base^start and base^stop are subject to floating-point rounding errors. Hence,

    var Complex64Vector = require( '@stdlib/ndarray-vector-complex64' );
    var Complex64 = require( '@stdlib/complex-float32-ctor' );
    var scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );
    
    var x = new Complex64Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
    
    var base = scalar2ndarray( 10.0, {
        'dtype': 'float32'
    });
    
    var strt = scalar2ndarray( new Complex64( 0.0, 0.0 ), {
        'dtype': 'complex64'
    });
    
    var stp = scalar2ndarray( new Complex64( 1.0, 0.0 ), {
        'dtype': 'complex64'
    });
    
    var endpoint = scalar2ndarray( true, {
        'dtype': 'bool'
    });
    
    clogspace( [ x, base, strt, stp, endpoint ] );
    
    var v = x.get( 1 );
    // returns <Complex64>[ ~3.162, 0.0 ]

    where v is only guaranteed to be approximately equal to the square root of 10.

  • When N = 1 and endpoint is false, only the base^start value is written to a provided input ndarray. When N = 1 and endpoint is true, only the base^stop value is written to a provided input ndarray.

  • Generated values follow a logarithmic spiral in the complex plane, where imaginary components of start and stop control phase rotation. If Re(start) < Re(stop), the magnitudes of the generated values are in ascending order; otherwise, the magnitudes are in descending order.

  • The input ndarray is mutated.

Examples

var Complex64Vector = require( '@stdlib/ndarray-vector-complex64' );
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var ndarraylike2scalar = require( '@stdlib/ndarray-ndarraylike2scalar' );
var clogspace = require( '@stdlib/blas-ext-base-ndarray-clogspace' );

var x = new Complex64Vector( 10 );
console.log( ndarray2array( x ) );

var base = scalar2ndarray( 10.0, {
    'dtype': 'float32'
});
console.log( 'Base: %d', ndarraylike2scalar( base ) );

var strt = scalar2ndarray( new Complex64( 0.0, 0.0 ), {
    'dtype': 'complex64'
});
console.log( 'Start: %s', ndarraylike2scalar( strt ) );

var stp = scalar2ndarray( new Complex64( 9.0, 1.0 ), {
    'dtype': 'complex64'
});
console.log( 'Stop: %s', ndarraylike2scalar( stp ) );

var endpoint = scalar2ndarray( true, {
    'dtype': 'bool'
});
console.log( 'Endpoint: %s', ndarraylike2scalar( endpoint ) );

clogspace( [ x, base, strt, stp, endpoint ] );
console.log( ndarray2array( x ) );

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.

About

Fill a one-dimensional single-precision complex floating-point ndarray with logarithmically spaced values over a specified interval.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages