Skip to content

Commit 2ae8150

Browse files
ujjwalv01ujjwalv01
committed
feat: add @stdlib/math/base/special/sinhf
1 parent 404e9c7 commit 2ae8150

24 files changed

Lines changed: 1731 additions & 0 deletions

File tree

‎lib/node_modules/@stdlib/math/base/special/sinhf/README.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<!--
2+
@license Apache-2.0
3+
4+
Copyright (c) 2026 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+
# sinhf
20+
21+
> Compute the hyperbolic sine of a single-precision floating-point number.
22+
23+
<section class="usage">
24+
25+
## Usage
26+
27+
```javascript
28+
var sinhf = require( '@stdlib/math/base/special/sinhf' );
29+
```
30+
31+
#### sinhf( x )
32+
33+
Computes the hyperbolic sine of a single-precision floating-point number.
34+
35+
```javascript
36+
var v = sinhf( 0.0 );
37+
// returns 0.0
38+
39+
v = sinhf( 2.0 );
40+
// returns ~3.627
41+
42+
v = sinhf( -2.0 );
43+
// returns ~-3.627
44+
45+
v = sinhf( NaN );
46+
// returns NaN
47+
```
48+
49+
</section>
50+
51+
<!-- /.usage -->
52+
53+
<section class="examples">
54+
55+
## Examples
56+
57+
<!-- eslint no-undef: "error" -->
58+
59+
```javascript
60+
var uniform = require( '@stdlib/random/base/uniform' );
61+
var sinhf = require( '@stdlib/math/base/special/sinhf' );
62+
63+
var x;
64+
var i;
65+
66+
for ( i = 0; i < 100; i++ ) {
67+
x = uniform( -5.0, 5.0 );
68+
console.log( 'sinh(%d) = %d', x, sinhf( x ) );
69+
}
70+
```
71+
72+
</section>
73+
74+
<!-- /.examples -->
75+
76+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
77+
78+
<section class="related">
79+
80+
</section>
81+
82+
<!-- /.related -->
83+
84+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
85+
86+
<section class="links">
87+
88+
</section>
89+
90+
<!-- /.links -->

‎lib/node_modules/@stdlib/math/base/special/sinhf/benchmark/benchmark.js‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 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 uniform = require( '@stdlib/random/base/uniform' );
25+
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
26+
var pkg = require( './../package.json' ).name;
27+
var sinhf = require( './../lib' );
28+
29+
30+
// MAIN //
31+
32+
bench( pkg, function benchmark( b ) {
33+
var x;
34+
var y;
35+
var i;
36+
37+
b.tic();
38+
for ( i = 0; i < b.iterations; i++ ) {
39+
x = uniform( -10.0, 10.0 );
40+
y = sinhf( x );
41+
if ( isnanf( y ) ) {
42+
b.fail( 'should not return NaN' );
43+
}
44+
}
45+
b.toc();
46+
if ( isnanf( y ) ) {
47+
b.fail( 'should not return NaN' );
48+
}
49+
b.pass( 'benchmark finished' );
50+
b.end();
51+
});

‎lib/node_modules/@stdlib/math/base/special/sinhf/benchmark/benchmark.native.js‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
26+
var uniform = require( '@stdlib/random/base/uniform' );
27+
var format = require( '@stdlib/string/format' );
28+
var tryRequire = require( '@stdlib/utils/try-require' );
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var sinhf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
35+
var opts = {
36+
'skip': ( sinhf instanceof Error )
37+
};
38+
39+
40+
// MAIN //
41+
42+
bench( format( '%s::native', pkg ), opts, function benchmark( b ) {
43+
var x;
44+
var y;
45+
var i;
46+
47+
b.tic();
48+
for ( i = 0; i < b.iterations; i++ ) {
49+
x = uniform( -10.0, 10.0 );
50+
y = sinhf( x );
51+
if ( isnanf( y ) ) {
52+
b.fail( 'should not return NaN' );
53+
}
54+
}
55+
b.toc();
56+
if ( isnanf( y ) ) {
57+
b.fail( 'should not return NaN' );
58+
}
59+
b.pass( 'benchmark finished' );
60+
b.end();
61+
});

‎lib/node_modules/@stdlib/math/base/special/sinhf/benchmark/c/Makefile‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2026 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+
else
25+
QUIET :=
26+
endif
27+
28+
# Determine the OS ([1][1], [2][2]).
29+
#
30+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
31+
# [2]: http://stackoverflow.com/a/27776822/2225624
32+
OS ?= $(shell uname)
33+
ifneq (, $(findstring MINGW,$(OS)))
34+
OS := WINNT
35+
else
36+
ifneq (, $(findstring MSYS,$(OS)))
37+
OS := WINNT
38+
else
39+
ifneq (, $(findstring CYGWIN,$(OS)))
40+
OS := WINNT
41+
else
42+
ifneq (, $(findstring Windows_NT,$(OS)))
43+
OS := WINNT
44+
endif
45+
endif
46+
endif
47+
endif
48+
49+
# Define the program used for compiling C source files:
50+
ifdef C_COMPILER
51+
CC := $(C_COMPILER)
52+
else
53+
CC := gcc
54+
endif
55+
56+
# Define the command-line options when compiling C files:
57+
CFLAGS ?= \
58+
-std=c99 \
59+
-O3 \
60+
-Wall \
61+
-pedantic
62+
63+
# Determine whether to generate position independent code ([1][1], [2][2]).
64+
#
65+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
66+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
67+
ifeq ($(OS), WINNT)
68+
fPIC ?=
69+
else
70+
fPIC ?= -fPIC
71+
endif
72+
73+
# List of C targets:
74+
c_targets := benchmark.out
75+
76+
77+
# RULES #
78+
79+
#/
80+
# Compiles C source files.
81+
#
82+
# @param {string} [C_COMPILER] - C compiler
83+
# @param {string} [CFLAGS] - C compiler flags
84+
# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code
85+
#
86+
# @example
87+
# make
88+
#
89+
# @example
90+
# make all
91+
#/
92+
all: $(c_targets)
93+
94+
.PHONY: all
95+
96+
#/
97+
# Compiles C source files.
98+
#
99+
# @private
100+
# @param {string} CC - C compiler
101+
# @param {string} CFLAGS - C compiler flags
102+
# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code
103+
#/
104+
$(c_targets): %.out: %.c
105+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) -o $@ $< -lm
106+
107+
#/
108+
# Runs compiled benchmarks.
109+
#
110+
# @example
111+
# make run
112+
#/
113+
run: $(c_targets)
114+
$(QUIET) ./$<
115+
116+
.PHONY: run
117+
118+
#/
119+
# Removes generated files.
120+
#
121+
# @example
122+
# make clean
123+
#/
124+
clean:
125+
$(QUIET) -rm -f *.o *.out
126+
127+
.PHONY: clean

0 commit comments

Comments
 (0)