Skip to content

Commit 0d8c569

Browse files
feat: benchmark added
1 parent 45d8ce5 commit 0d8c569

File tree

4 files changed

+357
-0
lines changed

4 files changed

+357
-0
lines changed
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2018 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var randu = require( '@stdlib/random/base/randu' );
25+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
26+
var pkg = require( './../package.json' ).name;
27+
const atan2f = require('@stdlib/math/base/special/atan2f');
28+
29+
30+
// MAIN //
31+
32+
bench( pkg, function benchmark( b ) {
33+
var x;
34+
var y;
35+
var z;
36+
var i;
37+
38+
b.tic();
39+
for ( i = 0; i < b.iterations; i++ ) {
40+
x = ( randu()*100.0 ) - 0.0;
41+
y = ( randu()*100.0 ) - 0.0;
42+
z = atan2f( x, y );
43+
if ( isnanf( z ) ) {
44+
b.fail( 'should not return NaN' );
45+
}
46+
}
47+
b.toc();
48+
if ( isnanf( z ) ) {
49+
b.fail( 'should not return NaN' );
50+
}
51+
b.pass( 'benchmark finished' );
52+
b.end();
53+
});
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var randu = require( '@stdlib/random/base/randu' );
26+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
27+
var tryRequire = require( '@stdlib/utils/try-require' );
28+
const atan2f = require('@stdlib/math/base/special/atan2f');
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var atan2f = tryRequire( resolve( __dirname, './../lib/native.js' ) );
35+
var opts = {
36+
'skip': ( atan2f instanceof Error )
37+
};
38+
39+
40+
// MAIN //
41+
42+
bench( pkg+'::native', opts, function benchmark( b ) {
43+
var x;
44+
var y;
45+
var z;
46+
var i;
47+
48+
b.tic();
49+
for ( i = 0; i < b.iterations; i++ ) {
50+
x = ( randu()*100.0 ) - 0.0;
51+
y = ( randu()*100.0 ) - 0.0;
52+
z = atan2f( y, x );
53+
if ( isnanf( z ) ) {
54+
b.fail( 'should not return NaN' );
55+
}
56+
}
57+
b.toc();
58+
if ( isnanf( z ) ) {
59+
b.fail( 'should not return NaN' );
60+
}
61+
b.pass( 'benchmark finished' );
62+
b.end();
63+
});
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2024 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
20+
# VARIABLES #
21+
22+
ifndef VERBOSE
23+
QUIET := @
24+
endif
25+
26+
# Determine the OS:
27+
#
28+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
29+
# [2]: http://stackoverflow.com/a/27776822/2225624
30+
OS ?= $(shell uname)
31+
ifneq (, $(findstring MINGW,$(OS)))
32+
OS := WINNT
33+
else
34+
ifneq (, $(findstring MSYS,$(OS)))
35+
OS := WINNT
36+
else
37+
ifneq (, $(findstring CYGWIN,$(OS)))
38+
OS := WINNT
39+
endif
40+
endif
41+
endif
42+
43+
# Define the program used for compiling C source files:
44+
ifdef C_COMPILER
45+
CC := $(C_COMPILER)
46+
else
47+
CC := gcc
48+
endif
49+
50+
# Define the command-line options when compiling C files:
51+
CFLAGS ?= \
52+
-std=c99 \
53+
-O3 \
54+
-Wall \
55+
-pedantic
56+
57+
# Determine whether to generate [position independent code][1]:
58+
#
59+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
60+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
61+
ifeq ($(OS), WINNT)
62+
fPIC ?=
63+
else
64+
fPIC ?= -fPIC
65+
endif
66+
67+
# List of C targets:
68+
c_targets := benchmark.out
69+
70+
71+
# TARGETS #
72+
73+
# Default target.
74+
#
75+
# This target is the default target.
76+
77+
all: $(c_targets)
78+
79+
.PHONY: all
80+
81+
82+
# Compile C source.
83+
#
84+
# This target compiles C source files.
85+
86+
$(c_targets): %.out: %.c
87+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) -o $@ $< -lm
88+
89+
90+
# Run a benchmark.
91+
#
92+
# This target runs a benchmark.
93+
94+
run: $(c_targets)
95+
$(QUIET) ./$<
96+
97+
.PHONY: run
98+
99+
100+
# Perform clean-up.
101+
#
102+
# This target removes generated files.
103+
104+
clean:
105+
$(QUIET) -rm -f *.o *.out
106+
107+
.PHONY: clean
Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#include <stdlib.h>
20+
#include <stdio.h>
21+
#include <math.h>
22+
#include <time.h>
23+
#include <sys/time.h>
24+
25+
#define NAME "atan2f"
26+
#define ITERATIONS 1000000
27+
#define REPEATS 3
28+
29+
/**
30+
* Prints the TAP version.
31+
*/
32+
static void print_version( void ) {
33+
printf( "TAP version 13\n" );
34+
}
35+
36+
/**
37+
* Prints the TAP summary.
38+
*
39+
* @param total total number of tests
40+
* @param passing total number of passing tests
41+
*/
42+
static void print_summary( int total, int passing ) {
43+
printf( "#\n" );
44+
printf( "1..%d\n", total ); // TAP plan
45+
printf( "# total %d\n", total );
46+
printf( "# pass %d\n", passing );
47+
printf( "#\n" );
48+
printf( "# ok\n" );
49+
}
50+
51+
/**
52+
* Prints benchmarks results.
53+
*
54+
* @param elapsed elapsed time in seconds
55+
*/
56+
static void print_results( double elapsed ) {
57+
double rate = (double)ITERATIONS / elapsed;
58+
printf( " ---\n" );
59+
printf( " iterations: %d\n", ITERATIONS );
60+
printf( " elapsed: %0.9f\n", elapsed );
61+
printf( " rate: %0.9f\n", rate );
62+
printf( " ...\n" );
63+
}
64+
65+
/**
66+
* Returns a clock time.
67+
*
68+
* @return clock time
69+
*/
70+
static double tic( void ) {
71+
struct timeval now;
72+
gettimeofday( &now, NULL );
73+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
74+
}
75+
76+
/**
77+
* Generates a random number on the interval [0,1).
78+
*
79+
* @return random number
80+
*/
81+
static float rand_float( void ) {
82+
int r = rand();
83+
return (float)r / ( (float)RAND_MAX + 1.0f );
84+
}
85+
86+
/**
87+
* Runs a benchmark.
88+
*
89+
* @return elapsed time in seconds
90+
*/
91+
static double benchmark( void ) {
92+
double elapsed;
93+
float x;
94+
float y;
95+
float z;
96+
double t;
97+
int i;
98+
99+
t = tic();
100+
for ( i = 0; i < ITERATIONS; i++ ) {
101+
x = ( 100.0f*rand_float() ) - 0.0f;
102+
y = ( 100.0f*rand_float() ) - 0.0f;
103+
z = atan2f( x, y );
104+
if ( z != z ) {
105+
printf( "should not return NaN\n" );
106+
break;
107+
}
108+
}
109+
elapsed = tic() - t;
110+
if ( z != z ) {
111+
printf( "should not return NaN\n" );
112+
}
113+
return elapsed;
114+
}
115+
116+
/**
117+
* Main execution sequence.
118+
*/
119+
int main( void ) {
120+
double elapsed;
121+
int i;
122+
123+
// Use the current time to seed the random number generator:
124+
srand( time( NULL ) );
125+
126+
print_version();
127+
for ( i = 0; i < REPEATS; i++ ) {
128+
printf( "# c::%s\n", NAME );
129+
elapsed = benchmark();
130+
print_results( elapsed );
131+
printf( "ok %d benchmark finished\n", i+1 );
132+
}
133+
print_summary( REPEATS, REPEATS );
134+
}

0 commit comments

Comments
 (0)