Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Jul 14, 2023
1 parent 92625db commit 2563df2
Show file tree
Hide file tree
Showing 16 changed files with 722 additions and 69 deletions.
46 changes: 33 additions & 13 deletions base/special/cidentity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ limitations under the License.
-->

# Identity Function
# cidentity

> Evaluate the [identity function][identity-function] of a double-precision [complex][@stdlib/complex/float64] floating-point number.
Expand Down Expand Up @@ -132,18 +132,26 @@ for ( i = 0; i < 100; i++ ) {
Evaluates the identity function for a double-precision complex floating-point number.

```c
#include <complex.h>
#include "stdlib/complex/float64.h"
#include "stdlib/complex/real.h"
#include "stdlib/complex/imag.h"

double complex y = stdlib_base_cidentity( 2.0+2.0*I );
// returns 2.0+2.0*I
stdlib_complex128_t z = stdlib_complex128( 2.5, -1.5 );
stdlib_complex128_t out = stdlib_base_cidentity( z );

double re = stdlib_real( out );
// returns 2.5

double im = stdlib_imag( out );
// returns -1.5
```

The function accepts the following arguments:

- **z**: `[in] double complex` input value.
- **z**: `[in] stdlib_complex128_t` input value.

```c
double complex stdlib_base_cidentity( const double complex z );
stdlib_complex128_t stdlib_base_cidentity( const stdlib_complex128_t z );
```
</section>
Expand All @@ -166,19 +174,31 @@ double complex stdlib_base_cidentity( const double complex z );
```c
#include "stdlib/math/base/special/cidentity.h"
#include "stdlib/complex/float64.h"
#include "stdlib/complex/reim.h"
#include <stdio.h>
#include <complex.h>
int main( void ) {
const double complex x[] = { 3.14+1.0*I, -3.14-1.0*I, 0.0+0.0*I, 0.0/0.0+0.0/0.0*I };
double complex v;
double complex y;
int main() {
const stdlib_complex128_t x[] = {
stdlib_complex128( 3.14, 1.5 ),
stdlib_complex128( -3.14, -1.5 ),
stdlib_complex128( 0.0, 0.0 ),
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
};
stdlib_complex128_t v;
stdlib_complex128_t y;
double re1;
double im1;
double re2;
double im2;
int i;
for ( i = 0; i < 4; i++ ) {
v = x[ i ];
y = stdlib_base_cidentity( v );
printf( "f(%lf + %lf) = %lf + %lf\n", creal( v ), cimag( v ), creal( y ), cimag( y ) );
stdlib_reim( v, &re1, &im1 );
stdlib_reim( y, &re2, &im2 );
printf( "cidentity(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 );
}
}
```
Expand Down
66 changes: 66 additions & 0 deletions base/special/cidentity/benchmark/benchmark.native.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/base/uniform' );
var isnan = require( './../../../../base/assert/is-nan' );
var Complex128 = require( '@stdlib/complex/float64' );
var real = require( '@stdlib/complex/real' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var cidentity = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( cidentity instanceof Error )
};


// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {
var values;
var y;
var i;

values = [
new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ),
new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) )
];

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = cidentity( values[ i%values.length ] );
if ( isnan( real( y ) ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( real( y ) ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#/
# @license Apache-2.0
#
# Copyright (c) 2021 The Stdlib Authors.
# Copyright (c) 2023 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -20,7 +20,8 @@
* Benchmark `cidentity`.
*/
#include "stdlib/math/base/special/cidentity.h"
#include <complex.h>
#include "stdlib/complex/float64.h"
#include "stdlib/complex/reim.h"
#include <stdlib.h>
#include <stdio.h>
#include <math.h>
Expand Down Expand Up @@ -94,25 +95,29 @@ double rand_double() {
* @return elapsed time in seconds
*/
double benchmark() {
double complex x;
double complex y;
double elapsed;
double re;
double im;
double t;
double v;
int i;

stdlib_complex128_t x;
stdlib_complex128_t y;

t = tic();
for ( i = 0; i < ITERATIONS; i++ ) {
v = ( 1000.0*rand_double() ) - 500.0;
x = v + v*I;
x = stdlib_complex128( v, v );
y = stdlib_base_cidentity( x );
if ( creal( y ) != v ) {
stdlib_reim( y, &re, &im );
if ( re != re ) {
printf( "unexpected result\n" );
break;
}
}
elapsed = tic() - t;
if ( cimag( y ) != v ) {
if ( im != im ) {
printf( "unexpected result\n" );
}
return elapsed;
Expand Down
170 changes: 170 additions & 0 deletions base/special/cidentity/binding.gyp
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
# @license Apache-2.0
#
# Copyright (c) 2023 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# A `.gyp` file for building a Node.js native add-on.
#
# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
{
# List of files to include in this file:
'includes': [
'./include.gypi',
],

# Define variables to be used throughout the configuration for all targets:
'variables': {
# Target name should match the add-on export name:
'addon_target_name%': 'addon',

# Set variables based on the host OS:
'conditions': [
[
'OS=="win"',
{
# Define the object file suffix:
'obj': 'obj',
},
{
# Define the object file suffix:
'obj': 'o',
}
], # end condition (OS=="win")
], # end conditions
}, # end variables

# Define compile targets:
'targets': [

# Target to generate an add-on:
{
# The target name should match the add-on export name:
'target_name': '<(addon_target_name)',

# Define dependencies:
'dependencies': [],

# Define directories which contain relevant include headers:
'include_dirs': [
# Local include directory:
'<@(include_dirs)',
],

# List of source files:
'sources': [
'<@(src_files)',
],

# Settings which should be applied when a target's object files are used as linker input:
'link_settings': {
# Define libraries:
'libraries': [
'<@(libraries)',
],

# Define library directories:
'library_dirs': [
'<@(library_dirs)',
],
},

# C/C++ compiler flags:
'cflags': [
# Enable commonly used warning options:
'-Wall',

# Aggressive optimization:
'-O3',
],

# C specific compiler flags:
'cflags_c': [
# Specify the C standard to which a program is expected to conform:
'-std=c99',
],

# C++ specific compiler flags:
'cflags_cpp': [
# Specify the C++ standard to which a program is expected to conform:
'-std=c++11',
],

# Linker flags:
'ldflags': [],

# Apply conditions based on the host OS:
'conditions': [
[
'OS=="mac"',
{
# Linker flags:
'ldflags': [
'-undefined dynamic_lookup',
'-Wl,-no-pie',
'-Wl,-search_paths_first',
],
},
], # end condition (OS=="mac")
[
'OS!="win"',
{
# C/C++ flags:
'cflags': [
# Generate platform-independent code:
'-fPIC',
],
},
], # end condition (OS!="win")
], # end conditions
}, # end target <(addon_target_name)

# Target to copy a generated add-on to a standard location:
{
'target_name': 'copy_addon',

# Declare that the output of this target is not linked:
'type': 'none',

# Define dependencies:
'dependencies': [
# Require that the add-on be generated before building this target:
'<(addon_target_name)',
],

# Define a list of actions:
'actions': [
{
'action_name': 'copy_addon',
'message': 'Copying addon...',

# Explicitly list the inputs in the command-line invocation below:
'inputs': [],

# Declare the expected outputs:
'outputs': [
'<(addon_output_dir)/<(addon_target_name).node',
],

# Define the command-line invocation:
'action': [
'cp',
'<(PRODUCT_DIR)/<(addon_target_name).node',
'<(addon_output_dir)/<(addon_target_name).node',
],
},
], # end actions
}, # end target copy_addon
], # end targets
}
2 changes: 1 addition & 1 deletion base/special/cidentity/examples/c/Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#/
# @license Apache-2.0
#
# Copyright (c) 2021 The Stdlib Authors.
# Copyright (c) 2023 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
Loading

0 comments on commit 2563df2

Please sign in to comment.