time-to-botec/squiggle/node_modules/@stdlib/math/base/special/kronecker-deltaf/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

3.9 KiB

Kronecker Delta

Evaluate the Kronecker delta (single-precision).

The Kronecker delta is defined as

Kronecker delta.

Usage

var kroneckerDeltaf = require( '@stdlib/math/base/special/kronecker-deltaf' );

kroneckerDeltaf( i, j )

Evaluates the Kronecker delta (single-precision).

var v = kroneckerDeltaf( 3.14, 3.14 );
// returns 1.0

v = kroneckerDeltaf( 3.14, 0.0 );
// returns 0.0

v = kroneckerDeltaf( NaN, 3.14 );
// returns NaN

v = kroneckerDeltaf( 3.14, NaN );
// returns NaN

v = kroneckerDeltaf( NaN, NaN );
// returns NaN

Examples

var linspace = require( '@stdlib/array/linspace' );
var kroneckerDeltaf = require( '@stdlib/math/base/special/kronecker-deltaf' );

var x = linspace( -1.0, 1.0, 101 );
var i;

for ( i = 0; i < x.length; i++ ) {
    console.log( 'kronecker(%d,%d) = %d', x[ i ], 0.0, kroneckerDeltaf( x[ i ], 0.0 ) );
}

C APIs

Usage

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

stdlib_base_kronecker_deltaf( i, j )

Evaluates the Kronecker delta (single-precision).

float v = stdlib_base_kronecker_deltaf( 3.0f, 3.0f );
// returns 1.0f

The function accepts the following arguments:

  • i: [in] float input value.
  • j: [in] float input value.
float stdlib_base_kronecker_delta( const float i, const float j );

Examples

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

int main() {
    float x[] = { 3.0f, 4.0f, 5.0f, 5.0f };

    float y;
    int i;
    for ( i = 0; i < 4; i += 2 ) {
        y = stdlib_base_kronecker_deltaf( x[ i ], x[ i+1 ] );
        printf( "kronecker_delta(%f, %f) = %f\n", x[ i ], x[ i+1 ], y );
    }
}