Skip to content

Commit 1913da4

Browse files
committed
Add C implementation
1 parent 0174845 commit 1913da4

File tree

17 files changed

+1110
-17
lines changed

17 files changed

+1110
-17
lines changed

lib/node_modules/@stdlib/math/base/special/labs/benchmark/benchmark.js

+2-14
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
25-
var minstd = require( '@stdlib/random/base/minstd' );
2624
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2725
var pkg = require( './../package.json' ).name;
2826
var labs = require( './../lib' );
@@ -31,17 +29,12 @@ var labs = require( './../lib' );
3129
// MAIN //
3230

3331
bench( pkg, function benchmark( b ) {
34-
var x;
3532
var y;
3633
var i;
3734

3835
b.tic();
3936
for ( i = 0; i < b.iterations; i++ ) {
40-
x = minstd();
41-
if ( randu() < 0.5 ) {
42-
x = -x;
43-
}
44-
y = labs( x|0 );
37+
y = labs( (-i)|0 );
4538
if ( isnan( y ) ) {
4639
b.fail( 'should not return NaN' );
4740
}
@@ -55,17 +48,12 @@ bench( pkg, function benchmark( b ) {
5548
});
5649

5750
bench( pkg+'::built-in', function benchmark( b ) {
58-
var x;
5951
var y;
6052
var i;
6153

6254
b.tic();
6355
for ( i = 0; i < b.iterations; i++ ) {
64-
x = minstd();
65-
if ( randu() < 0.5 ) {
66-
x = -x;
67-
}
68-
y = Math.abs( x|0 ); // eslint-disable-line stdlib/no-builtin-math
56+
y = Math.abs( (-i)|0 ); // eslint-disable-line stdlib/no-builtin-math
6957
if ( isnan( y ) ) {
7058
b.fail( 'should not return NaN' );
7159
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2020 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
26+
var tryRequire = require( '@stdlib/utils/try-require' );
27+
var pkg = require( './../package.json' ).name;
28+
29+
30+
// VARIABLES //
31+
32+
var labs = tryRequire( resolve( __dirname, './../lib/native.js' ) );
33+
var opts = {
34+
'skip': ( labs instanceof Error )
35+
};
36+
37+
38+
// MAIN //
39+
40+
bench( pkg+'::native', opts, function benchmark( b ) {
41+
var y;
42+
var i;
43+
44+
b.tic();
45+
for ( i = 0; i < b.iterations; i++ ) {
46+
y = labs( (-i)|0 );
47+
if ( isnan( y ) ) {
48+
b.fail( 'should not return NaN' );
49+
}
50+
}
51+
b.toc();
52+
if ( isnan( y ) ) {
53+
b.fail( 'should not return NaN' );
54+
}
55+
b.pass( 'benchmark finished' );
56+
b.end();
57+
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2020 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+
# VARIABLES #
20+
21+
ifndef VERBOSE
22+
QUIET := @
23+
else
24+
QUIET :=
25+
endif
26+
27+
# Determine the OS ([1][1], [2][2]).
28+
#
29+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
30+
# [2]: http://stackoverflow.com/a/27776822/2225624
31+
OS ?= $(shell uname)
32+
ifneq (, $(findstring MINGW,$(OS)))
33+
OS := WINNT
34+
else
35+
ifneq (, $(findstring MSYS,$(OS)))
36+
OS := WINNT
37+
else
38+
ifneq (, $(findstring CYGWIN,$(OS)))
39+
OS := WINNT
40+
else
41+
ifneq (, $(findstring Windows_NT,$(OS)))
42+
OS := WINNT
43+
endif
44+
endif
45+
endif
46+
endif
47+
48+
# Define the program used for compiling C source files:
49+
ifdef C_COMPILER
50+
CC := $(C_COMPILER)
51+
else
52+
CC := gcc
53+
endif
54+
55+
# Define the command-line options when compiling C files:
56+
CFLAGS ?= \
57+
-std=c99 \
58+
-O3 \
59+
-Wall \
60+
-pedantic
61+
62+
# Determine whether to generate position independent code ([1][1], [2][2]).
63+
#
64+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
65+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
66+
ifeq ($(OS), WINNT)
67+
fPIC ?=
68+
else
69+
fPIC ?= -fPIC
70+
endif
71+
72+
# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
73+
INCLUDE ?=
74+
75+
# List of source files:
76+
SOURCE_FILES ?=
77+
78+
# List of libraries (e.g., `-lopenblas -lpthread`):
79+
LIBRARIES ?=
80+
81+
# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
82+
LIBPATH ?=
83+
84+
# List of C targets:
85+
c_targets := benchmark.out
86+
87+
88+
# RULES #
89+
90+
#/
91+
# Compiles source files.
92+
#
93+
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
94+
# @param {string} [CFLAGS] - C compiler options
95+
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
96+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
97+
# @param {string} [SOURCE_FILES] - list of source files
98+
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
99+
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
100+
#
101+
# @example
102+
# make
103+
#
104+
# @example
105+
# make all
106+
#/
107+
all: $(c_targets)
108+
109+
.PHONY: all
110+
111+
#/
112+
# Compiles C source files.
113+
#
114+
# @private
115+
# @param {string} CC - C compiler (e.g., `gcc`)
116+
# @param {string} CFLAGS - C compiler options
117+
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
118+
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
119+
# @param {string} SOURCE_FILES - list of source files
120+
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
121+
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
122+
#/
123+
$(c_targets): %.out: %.c
124+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)
125+
126+
#/
127+
# Runs compiled benchmarks.
128+
#
129+
# @example
130+
# make run
131+
#/
132+
run: $(c_targets)
133+
$(QUIET) ./$<
134+
135+
.PHONY: run
136+
137+
#/
138+
# Removes generated files.
139+
#
140+
# @example
141+
# make clean
142+
#/
143+
clean:
144+
$(QUIET) -rm -f *.o *.out
145+
146+
.PHONY: clean
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2020 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+
* Benchmark `labs`.
21+
*/
22+
#include "stdlib/math/base/special/labs.h"
23+
#include <stdlib.h>
24+
#include <stdio.h>
25+
#include <math.h>
26+
#include <time.h>
27+
#include <time.h>
28+
#include <sys/time.h>
29+
30+
#define NAME "labs"
31+
#define ITERATIONS 1000000
32+
#define REPEATS 3
33+
34+
/**
35+
* Prints the TAP version.
36+
*/
37+
void print_version() {
38+
printf( "TAP version 13\n" );
39+
}
40+
41+
/**
42+
* Prints the TAP summary.
43+
*
44+
* @param total total number of tests
45+
* @param passing total number of passing tests
46+
*/
47+
void print_summary( int total, int passing ) {
48+
printf( "#\n" );
49+
printf( "1..%d\n", total ); // TAP plan
50+
printf( "# total %d\n", total );
51+
printf( "# pass %d\n", passing );
52+
printf( "#\n" );
53+
printf( "# ok\n" );
54+
}
55+
56+
/**
57+
* Prints benchmarks results.
58+
*
59+
* @param elapsed elapsed time in seconds
60+
*/
61+
void print_results( double elapsed ) {
62+
double rate = (double)ITERATIONS / elapsed;
63+
printf( " ---\n" );
64+
printf( " iterations: %d\n", ITERATIONS );
65+
printf( " elapsed: %0.9f\n", elapsed );
66+
printf( " rate: %0.9f\n", rate );
67+
printf( " ...\n" );
68+
}
69+
70+
/**
71+
* Returns a clock time.
72+
*
73+
* @return clock time
74+
*/
75+
double tic() {
76+
struct timeval now;
77+
gettimeofday( &now, NULL );
78+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
79+
}
80+
81+
/**
82+
* Runs a benchmark.
83+
*
84+
* @return elapsed time in seconds
85+
*/
86+
double benchmark() {
87+
double elapsed;
88+
double t;
89+
int x;
90+
int y;
91+
int i;
92+
93+
t = tic();
94+
for ( i = 0; i < ITERATIONS; i++ ) {
95+
x = i - ITERATIONS;
96+
y = stdlib_base_labs( x );
97+
if ( y < 0 ) {
98+
printf( "should not return a negative number\n" );
99+
break;
100+
}
101+
}
102+
elapsed = tic() - t;
103+
if ( y < 0 ) {
104+
printf( "should not return a negative number\n" );
105+
}
106+
return elapsed;
107+
}
108+
109+
/**
110+
* Main execution sequence.
111+
*/
112+
int main( void ) {
113+
double elapsed;
114+
int i;
115+
116+
// Use the current time to seed the random number generator:
117+
srand( time( NULL ) );
118+
119+
print_version();
120+
for ( i = 0; i < REPEATS; i++ ) {
121+
printf( "# c::native::%s\n", NAME );
122+
elapsed = benchmark();
123+
print_results( elapsed );
124+
printf( "ok %d benchmark finished\n", i+1 );
125+
}
126+
print_summary( REPEATS, REPEATS );
127+
}

0 commit comments

Comments
 (0)