@stdlib/math-base-special-ceil10 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -139,6 +139,91 @@ for ( i = 0; i < 100; i++ ) {
139
139
 
140
140
  <!-- /.examples -->
141
141
 
142
+ <!-- C interface documentation. -->
143
+
144
+ * * *
145
+
146
+ <section class="c">
147
+
148
+ ## C APIs
149
+
150
+ <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
151
+
152
+ <section class="intro">
153
+
154
+ </section>
155
+
156
+ <!-- /.intro -->
157
+
158
+ <!-- C usage documentation. -->
159
+
160
+ <section class="usage">
161
+
162
+ ### Usage
163
+
164
+ ```c
165
+ #include "stdlib/math/base/special/ceil10.h"
166
+ ```
167
+
168
+ #### stdlib_base_ceil10( x )
169
+
170
+ Rounds a `numeric` value to the nearest power of `10` toward positive infinity.
171
+
172
+ ```c
173
+ double y = stdlib_base_ceil10( -4.2 );
174
+ // returns -1.0
175
+ ```
176
+
177
+ The function accepts the following arguments:
178
+
179
+ - **x**: `[in] double` input value.
180
+
181
+ ```c
182
+ double stdlib_base_ceil10( const double x );
183
+ ```
184
+
185
+ </section>
186
+
187
+ <!-- /.usage -->
188
+
189
+ <!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
190
+
191
+ <section class="notes">
192
+
193
+ </section>
194
+
195
+ <!-- /.notes -->
196
+
197
+ <!-- C API usage examples. -->
198
+
199
+ <section class="examples">
200
+
201
+ ### Examples
202
+
203
+ ```c
204
+ #include "stdlib/math/base/special/ceil10.h"
205
+ #include <stdio.h>
206
+
207
+ int main( void ) {
208
+ const double x[] = { 3.14, -3.14, 0.0, 9.0 / 0.0 };
209
+
210
+ double y;
211
+ int i;
212
+ for ( i = 0; i < 4; i++ ) {
213
+ y = stdlib_base_ceil10( x[ i ] );
214
+ printf( "ceil10(%lf) = %lf\n", x[ i ], y );
215
+ }
216
+ }
217
+ ```
218
+
219
+ </section>
220
+
221
+ <!-- /.examples -->
222
+
223
+ </section>
224
+
225
+ <!-- /.c -->
226
+
142
227
  <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
143
228
 
144
229
  <section class="related">
@@ -195,8 +280,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
195
280
  [npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-ceil10.svg
196
281
  [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-ceil10
197
282
 
198
- [test-image]: https://github.com/stdlib-js/math-base-special-ceil10/actions/workflows/test.yml/badge.svg?branch=v0.2.0
199
- [test-url]: https://github.com/stdlib-js/math-base-special-ceil10/actions/workflows/test.yml?query=branch:v0.2.0
283
+ [test-image]: https://github.com/stdlib-js/math-base-special-ceil10/actions/workflows/test.yml/badge.svg?branch=v0.3.0
284
+ [test-url]: https://github.com/stdlib-js/math-base-special-ceil10/actions/workflows/test.yml?query=branch:v0.3.0
200
285
 
201
286
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-ceil10/main.svg
202
287
  [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-ceil10?branch=main
@@ -0,0 +1,38 @@
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
+ #ifndef STDLIB_MATH_BASE_SPECIAL_CEIL10_H
20
+ #define STDLIB_MATH_BASE_SPECIAL_CEIL10_H
21
+
22
+ /*
23
+ * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
24
+ */
25
+ #ifdef __cplusplus
26
+ extern "C" {
27
+ #endif
28
+
29
+ /**
30
+ * Rounds a numeric value to the nearest power of `10` toward positive infinity.
31
+ */
32
+ double stdlib_base_ceil10( const double x );
33
+
34
+ #ifdef __cplusplus
35
+ }
36
+ #endif
37
+
38
+ #endif // !STDLIB_MATH_BASE_SPECIAL_CEIL10_H
package/lib/native.js ADDED
@@ -0,0 +1,54 @@
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 addon = require( './../src/addon.node' );
24
+
25
+
26
+ // MAIN //
27
+
28
+ /**
29
+ * Rounds a numeric value to the nearest power of `10` toward positive infinity.
30
+ *
31
+ * @private
32
+ * @param {number} x - input value
33
+ * @returns {number} rounded value
34
+ *
35
+ * @example
36
+ * var v = ceil10( 3.141592653589793 );
37
+ * // returns 10.0
38
+ *
39
+ * @example
40
+ * var v = ceil10( 9.0 );
41
+ * // returns 10.0
42
+ *
43
+ * @example
44
+ * var v = ceil10( -0.314 );
45
+ * // returns -0.1
46
+ */
47
+ function ceil10( x ) {
48
+ return addon( x );
49
+ }
50
+
51
+
52
+ // EXPORTS //
53
+
54
+ module.exports = ceil10;
package/manifest.json ADDED
@@ -0,0 +1,102 @@
1
+ {
2
+ "options": {
3
+ "task": "build"
4
+ },
5
+ "fields": [
6
+ {
7
+ "field": "src",
8
+ "resolve": true,
9
+ "relative": true
10
+ },
11
+ {
12
+ "field": "include",
13
+ "resolve": true,
14
+ "relative": true
15
+ },
16
+ {
17
+ "field": "libraries",
18
+ "resolve": false,
19
+ "relative": false
20
+ },
21
+ {
22
+ "field": "libpath",
23
+ "resolve": true,
24
+ "relative": false
25
+ }
26
+ ],
27
+ "confs": [
28
+ {
29
+ "task": "build",
30
+ "src": [
31
+ "./src/main.c"
32
+ ],
33
+ "include": [
34
+ "./include"
35
+ ],
36
+ "libraries": [
37
+ "-lm"
38
+ ],
39
+ "libpath": [],
40
+ "dependencies": [
41
+ "@stdlib/math-base-napi-unary",
42
+ "@stdlib/math-base-assert-is-nan",
43
+ "@stdlib/math-base-assert-is-infinite",
44
+ "@stdlib/math-base-special-pow",
45
+ "@stdlib/math-base-special-floor",
46
+ "@stdlib/math-base-special-ceil",
47
+ "@stdlib/math-base-special-log10",
48
+ "@stdlib/constants-float64-max-base10-exponent",
49
+ "@stdlib/constants-float64-min-base10-exponent-subnormal",
50
+ "@stdlib/constants-float64-pinf"
51
+ ]
52
+ },
53
+ {
54
+ "task": "benchmark",
55
+ "src": [
56
+ "./src/main.c"
57
+ ],
58
+ "include": [
59
+ "./include"
60
+ ],
61
+ "libraries": [
62
+ "-lm"
63
+ ],
64
+ "libpath": [],
65
+ "dependencies": [
66
+ "@stdlib/math-base-assert-is-nan",
67
+ "@stdlib/math-base-assert-is-infinite",
68
+ "@stdlib/math-base-special-pow",
69
+ "@stdlib/math-base-special-floor",
70
+ "@stdlib/math-base-special-ceil",
71
+ "@stdlib/math-base-special-log10",
72
+ "@stdlib/constants-float64-max-base10-exponent",
73
+ "@stdlib/constants-float64-min-base10-exponent-subnormal",
74
+ "@stdlib/constants-float64-pinf"
75
+ ]
76
+ },
77
+ {
78
+ "task": "examples",
79
+ "src": [
80
+ "./src/main.c"
81
+ ],
82
+ "include": [
83
+ "./include"
84
+ ],
85
+ "libraries": [
86
+ "-lm"
87
+ ],
88
+ "libpath": [],
89
+ "dependencies": [
90
+ "@stdlib/math-base-assert-is-nan",
91
+ "@stdlib/math-base-assert-is-infinite",
92
+ "@stdlib/math-base-special-pow",
93
+ "@stdlib/math-base-special-floor",
94
+ "@stdlib/math-base-special-ceil",
95
+ "@stdlib/math-base-special-log10",
96
+ "@stdlib/constants-float64-max-base10-exponent",
97
+ "@stdlib/constants-float64-min-base10-exponent-subnormal",
98
+ "@stdlib/constants-float64-pinf"
99
+ ]
100
+ }
101
+ ]
102
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/math-base-special-ceil10",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "Round a numeric value to the nearest power of 10 toward positive infinity.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -14,20 +14,16 @@
14
14
  }
15
15
  ],
16
16
  "main": "./lib",
17
+ "gypfile": false,
17
18
  "directories": {
18
- "benchmark": "./benchmark",
19
19
  "doc": "./docs",
20
- "example": "./examples",
20
+ "include": "./include",
21
21
  "lib": "./lib",
22
- "test": "./test"
22
+ "src": "./src",
23
+ "dist": "./dist"
23
24
  },
24
25
  "types": "./docs/types",
25
- "scripts": {
26
- "test": "make test",
27
- "test-cov": "make test-cov",
28
- "examples": "make examples",
29
- "benchmark": "make benchmark"
30
- },
26
+ "scripts": {},
31
27
  "homepage": "https://stdlib.io",
32
28
  "repository": {
33
29
  "type": "git",
@@ -37,27 +33,19 @@
37
33
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
34
  },
39
35
  "dependencies": {
40
- "@stdlib/constants-float64-max-base10-exponent": "^0.2.0",
41
- "@stdlib/constants-float64-min-base10-exponent-subnormal": "^0.2.0",
42
- "@stdlib/constants-float64-pinf": "^0.2.0",
43
- "@stdlib/math-base-assert-is-infinite": "^0.2.0",
44
- "@stdlib/math-base-assert-is-nan": "^0.2.0",
45
- "@stdlib/math-base-special-ceil": "^0.2.0",
46
- "@stdlib/math-base-special-floor": "^0.2.0",
47
- "@stdlib/math-base-special-log10": "^0.2.0",
48
- "@stdlib/math-base-special-pow": "^0.2.0"
49
- },
50
- "devDependencies": {
51
- "@stdlib/constants-float64-ninf": "^0.1.1",
52
- "@stdlib/math-base-assert-is-negative-zero": "^0.1.1",
53
- "@stdlib/math-base-assert-is-positive-zero": "^0.1.1",
54
- "@stdlib/random-base-randu": "^0.1.0",
55
- "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
56
- "istanbul": "^0.4.1",
57
- "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
58
- "@stdlib/bench-harness": "^0.2.0",
59
- "@stdlib/bench": "^0.3.1"
36
+ "@stdlib/constants-float64-max-base10-exponent": "^0.2.2",
37
+ "@stdlib/constants-float64-min-base10-exponent-subnormal": "^0.2.1",
38
+ "@stdlib/constants-float64-pinf": "^0.2.2",
39
+ "@stdlib/math-base-assert-is-infinite": "^0.2.2",
40
+ "@stdlib/math-base-assert-is-nan": "^0.2.2",
41
+ "@stdlib/math-base-napi-unary": "^0.2.3",
42
+ "@stdlib/math-base-special-ceil": "^0.2.2",
43
+ "@stdlib/math-base-special-floor": "^0.2.3",
44
+ "@stdlib/math-base-special-log10": "^0.3.0",
45
+ "@stdlib/math-base-special-pow": "^0.3.0",
46
+ "@stdlib/utils-library-manifest": "^0.2.2"
60
47
  },
48
+ "devDependencies": {},
61
49
  "engines": {
62
50
  "node": ">=0.10.0",
63
51
  "npm": ">2.7.0"
package/src/addon.c ADDED
@@ -0,0 +1,22 @@
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/math/base/special/ceil10.h"
20
+ #include "stdlib/math/base/napi/unary.h"
21
+
22
+ STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_ceil10 )
package/src/main.c ADDED
@@ -0,0 +1,76 @@
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/math/base/special/ceil10.h"
20
+ #include "stdlib/math/base/assert/is_nan.h"
21
+ #include "stdlib/math/base/assert/is_infinite.h"
22
+ #include "stdlib/math/base/special/pow.h"
23
+ #include "stdlib/math/base/special/floor.h"
24
+ #include "stdlib/math/base/special/ceil.h"
25
+ #include "stdlib/math/base/special/log10.h"
26
+ #include "stdlib/constants/float64/max_base10_exponent.h"
27
+ #include "stdlib/constants/float64/min_base10_exponent_subnormal.h"
28
+ #include "stdlib/constants/float64/pinf.h"
29
+
30
+ /**
31
+ * Rounds a numeric value to the nearest power of `10` toward positive infinity.
32
+ *
33
+ * @param x input value
34
+ * @return rounded value
35
+ *
36
+ * @example
37
+ * double y = stdlib_base_ceil10( 3.141592653589793 );
38
+ * // returns 10.0
39
+ */
40
+ double stdlib_base_ceil10( const double x ) {
41
+ double sign;
42
+ double xc;
43
+ double p;
44
+
45
+ if ( stdlib_base_is_nan( x ) || stdlib_base_is_infinite( x ) || x == 0.0 ) {
46
+ return x;
47
+ }
48
+ xc = x;
49
+ if ( x < 0 ) {
50
+ xc = -xc;
51
+ sign = -1.0;
52
+ } else {
53
+ sign = 1.0;
54
+ }
55
+
56
+ // Solve the equation `10^p = x` for `p`:
57
+ p = stdlib_base_log10( xc );
58
+
59
+ // Determine a power of `10` which rounds the input value toward positive infinity:
60
+ if ( sign == -1.0 ) {
61
+ p = stdlib_base_floor( p );
62
+ } else {
63
+ p = stdlib_base_ceil( p );
64
+ }
65
+
66
+ // Handle underflow:
67
+ if ( p <= STDLIB_CONSTANT_FLOAT64_MIN_BASE10_EXPONENT_SUBNORMAL ) {
68
+ return sign * 0.0; // sign-preserving
69
+ }
70
+
71
+ // Handle overflow:
72
+ if ( p > STDLIB_CONSTANT_FLOAT64_MAX_BASE10_EXPONENT ) {
73
+ return STDLIB_CONSTANT_FLOAT64_PINF;
74
+ }
75
+ return sign * stdlib_base_pow( 10.0, p );
76
+ }