Skip to content

Commit d8b965b

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
bench: add native and fortran benchmarks
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent a1546ab commit d8b965b

File tree

4 files changed

+597
-0
lines changed

4 files changed

+597
-0
lines changed
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
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 uniform = require( '@stdlib/random/array/uniform' );
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var pow = require( '@stdlib/math/base/special/pow' );
28+
var Complex128Array = require( '@stdlib/array/complex128' );
29+
var Complex128 = require( '@stdlib/complex/float64/ctor' );
30+
var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
31+
var tryRequire = require( '@stdlib/utils/try-require' );
32+
var pkg = require( './../package.json' ).name;
33+
34+
35+
// VARIABLES //
36+
37+
var zaxpy = tryRequire( resolve( __dirname, './../lib/zaxpy.native.js' ) );
38+
var opts = {
39+
'skip': ( zaxpy instanceof Error )
40+
};
41+
var options = {
42+
'dtype': 'float64'
43+
};
44+
45+
46+
// FUNCTIONS //
47+
48+
/**
49+
* Creates a benchmark function.
50+
*
51+
* @private
52+
* @param {PositiveInteger} N - array length
53+
* @returns {Function} benchmark function
54+
*/
55+
function createBenchmark( N ) {
56+
var viewY;
57+
var alpha;
58+
var x;
59+
var y;
60+
61+
x = new Complex128Array( uniform( N*2, -100.0, 100.0, options ) );
62+
y = new Complex128Array( uniform( N*2, -100.0, 100.0, options ) );
63+
64+
viewY = reinterpret( y, 0 );
65+
66+
alpha = new Complex128( 1.0, 0.0 );
67+
68+
return benchmark;
69+
70+
/**
71+
* Benchmark function.
72+
*
73+
* @private
74+
* @param {Benchmark} b - benchmark instance
75+
*/
76+
function benchmark( b ) {
77+
var i;
78+
79+
b.tic();
80+
for ( i = 0; i < b.iterations; i++ ) {
81+
zaxpy( x.length, alpha, x, 1, y, 1 );
82+
if ( isnan( viewY[ i%(N*2) ] ) ) {
83+
b.fail( 'should not return NaN' );
84+
}
85+
}
86+
b.toc();
87+
if ( isnan( viewY[ i%(N*2) ] ) ) {
88+
b.fail( 'should not return NaN' );
89+
}
90+
b.pass( 'benchmark finished' );
91+
b.end();
92+
}
93+
}
94+
95+
96+
// MAIN //
97+
98+
/**
99+
* Main execution sequence.
100+
*
101+
* @private
102+
*/
103+
function main() {
104+
var min;
105+
var max;
106+
var N;
107+
var f;
108+
var i;
109+
110+
min = 1; // 10^min
111+
max = 6; // 10^max
112+
113+
for ( i = min; i <= max; i++ ) {
114+
N = pow( 10, i );
115+
f = createBenchmark( N );
116+
bench( pkg+'::native:size='+N, opts, f );
117+
}
118+
}
119+
120+
main();
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
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 uniform = require( '@stdlib/random/array/uniform' );
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var pow = require( '@stdlib/math/base/special/pow' );
28+
var Complex128Array = require( '@stdlib/array/complex128' );
29+
var Complex128 = require( '@stdlib/complex/float64/ctor' );
30+
var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
31+
var tryRequire = require( '@stdlib/utils/try-require' );
32+
var pkg = require( './../package.json' ).name;
33+
34+
35+
// VARIABLES //
36+
37+
var zaxpy = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
38+
var opts = {
39+
'skip': ( zaxpy instanceof Error )
40+
};
41+
var options = {
42+
'dtype': 'float64'
43+
};
44+
45+
46+
// FUNCTIONS //
47+
48+
/**
49+
* Creates a benchmark function.
50+
*
51+
* @private
52+
* @param {PositiveInteger} N - array length
53+
* @returns {Function} benchmark function
54+
*/
55+
function createBenchmark( N ) {
56+
var viewY;
57+
var alpha;
58+
var x;
59+
var y;
60+
61+
x = new Complex128Array( uniform( N*2, -100.0, 100.0, options ) );
62+
y = new Complex128Array( uniform( N*2, -100.0, 100.0, options ) );
63+
64+
viewY = reinterpret( y, 0 );
65+
66+
alpha = new Complex128( 1.0, 0.0 );
67+
68+
return benchmark;
69+
70+
/**
71+
* Benchmark function.
72+
*
73+
* @private
74+
* @param {Benchmark} b - benchmark instance
75+
*/
76+
function benchmark( b ) {
77+
var i;
78+
79+
b.tic();
80+
for ( i = 0; i < b.iterations; i++ ) {
81+
zaxpy( x.length, alpha, x, 1, 0, y, 1, 0 );
82+
if ( isnan( viewY[ i%(N*2) ] ) ) {
83+
b.fail( 'should not return NaN' );
84+
}
85+
}
86+
b.toc();
87+
if ( isnan( viewY[ i%(N*2) ] ) ) {
88+
b.fail( 'should not return NaN' );
89+
}
90+
b.pass( 'benchmark finished' );
91+
b.end();
92+
}
93+
}
94+
95+
96+
// MAIN //
97+
98+
/**
99+
* Main execution sequence.
100+
*
101+
* @private
102+
*/
103+
function main() {
104+
var min;
105+
var max;
106+
var N;
107+
var f;
108+
var i;
109+
110+
min = 1; // 10^min
111+
max = 6; // 10^max
112+
113+
for ( i = min; i <= max; i++ ) {
114+
N = pow( 10, i );
115+
f = createBenchmark( N );
116+
bench( pkg+'::native:ndarray:size='+N, opts, f );
117+
}
118+
}
119+
120+
main();
Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
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+
# 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 Fortran source files:
49+
ifdef FORTRAN_COMPILER
50+
FC := $(FORTRAN_COMPILER)
51+
else
52+
FC := gfortran
53+
endif
54+
55+
# Define the command-line options when compiling Fortran files:
56+
FFLAGS ?= \
57+
-std=f95 \
58+
-ffree-form \
59+
-O3 \
60+
-Wall \
61+
-Wextra \
62+
-Wno-compare-reals \
63+
-Wimplicit-interface \
64+
-fno-underscoring \
65+
-pedantic
66+
67+
# Determine whether to generate position independent code ([1][1], [2][2]).
68+
#
69+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
70+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
71+
ifeq ($(OS), WINNT)
72+
fPIC ?=
73+
else
74+
fPIC ?= -fPIC
75+
endif
76+
77+
# List of includes (e.g., `-I /foo/bar -I /beep/boop`):
78+
INCLUDE ?=
79+
80+
# List of Fortran source files:
81+
SOURCE_FILES ?= ../../src/zaxpy.f
82+
83+
# List of Fortran targets:
84+
f_targets := benchmark.length.out
85+
86+
87+
# RULES #
88+
89+
#/
90+
# Compiles Fortran source files.
91+
#
92+
# @param {string} SOURCE_FILES - list of Fortran source files
93+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop`)
94+
# @param {string} [FORTRAN_COMPILER] - Fortran compiler
95+
# @param {string} [FFLAGS] - Fortran compiler flags
96+
# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code
97+
#
98+
# @example
99+
# make
100+
#
101+
# @example
102+
# make all
103+
#/
104+
all: $(f_targets)
105+
106+
.PHONY: all
107+
108+
#/
109+
# Compiles Fortran source files.
110+
#
111+
# @private
112+
# @param {string} SOURCE_FILES - list of Fortran source files
113+
# @param {(string|void)} INCLUDE - list of includes (e.g., `-I /foo/bar -I /beep/boop`)
114+
# @param {string} FC - Fortran compiler
115+
# @param {string} FFLAGS - Fortran compiler flags
116+
# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code
117+
#/
118+
$(f_targets): %.out: %.f
119+
$(QUIET) $(FC) $(FFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $<
120+
121+
#/
122+
# Runs compiled benchmarks.
123+
#
124+
# @example
125+
# make run
126+
#/
127+
run: $(f_targets)
128+
$(QUIET) ./$<
129+
130+
.PHONY: run
131+
132+
#/
133+
# Removes generated files.
134+
#
135+
# @example
136+
# make clean
137+
#/
138+
clean:
139+
$(QUIET) -rm -f *.o *.out
140+
141+
.PHONY: clean

0 commit comments

Comments
 (0)