@stdlib/math-base-special-cidentityf NPM

Identity Function

$NPM version$ $Build Status$ $Coverage Status$

Evaluate the identity function of a single-precision complex floating-point number.

for all z.

Installation

npm install @stdlib/math-base-special-cidentityf

Usage

var cidentityf = require( '@stdlib/math-base-special-cidentityf' );

cidentityf( z )

Evaluates the identity function for a single-precision complex floating-point number.

var Complex64 = require( '@stdlib/complex-float32-ctor' );
var real = require( '@stdlib/complex-float32-real' );
var imag = require( '@stdlib/complex-float32-imag' );

var v = cidentityf( new Complex64( -1.0, 2.0 ) );
// returns <Complex64>

var re = real( v );
// returns -1.0

var im = imag( v );
// returns 2.0

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var cidentityf = require( '@stdlib/math-base-special-cidentityf' );

var z;
var i;
for ( i = 0; i < 100; i++ ) {
    z = new Complex64( discreteUniform( -50, 50 ), discreteUniform( -50, 50 ) );
    console.log( 'identity(%s) = %s', z, cidentityf( z ) );
}

C APIs

Usage

#include "stdlib/math/base/special/cidentityf.h"

stdlib_base_cidentityf( z )

Evaluates the identity function for a single-precision complex floating-point number.

#include <complex.h>

float complex y = stdlib_base_cidentityf( 2.0f+2.0f*I );
// returns 2.0f+2.0f*I

The function accepts the following arguments:

z: [in] float complex input value.

float complex stdlib_base_cidentityf( const float complex z );

Examples

#include "stdlib/math/base/special/cidentityf.h"
#include <stdio.h>
#include <complex.h>

int main( void ) {
    const float complex x[] = { 3.14f+1.0f*I, -3.14f-1.0f*I, 0.0f+0.0f*I, 0.0f/0.0f+0.0f/0.0f*I };

    float complex v;
    float complex y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = x[ i ];
        y = stdlib_base_cidentityf( v );
        printf( "f(%f + %f) = %f + %f\n", crealf( v ), cimagf( v ), crealf( y ), cimagf( y ) );
    }
}

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.