@stdlib/math-base-special-floor10 0.2.1 → 0.3.0

package/README.md

@@ -139,6 +139,91 @@ for ( i = 0; i < 100; i++ ) {
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/math/base/special/floor10.h"
+```
+
+#### stdlib_base_floor10( x )
+
+Rounds a `numeric` value to the nearest power of `10` toward negative infinity.
+
+```c
+double y = stdlib_base_floor10( -4.2 );
+// returns -10.0
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] double` input value.
+
+```c
+double stdlib_base_floor10( const double x );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/math/base/special/floor10.h"
+#include <stdio.h>
+
+int main( void ) {
+    const double x[] = { 3.14, -3.14, 0.0, 9.0 / 0.0 };
+
+    double y;
+    int i;
+    for ( i = 0; i < 4; i++ ) {
+        y = stdlib_base_floor10( x[ i ] );
+        printf( "floor10(%lf) = %lf\n", x[ i ], y );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">
@@ -195,8 +280,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-floor10.svg
 [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-floor10
 
-[test-image]: https://github.com/stdlib-js/math-base-special-floor10/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/math-base-special-floor10/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/math-base-special-floor10/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/math-base-special-floor10/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-floor10/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-floor10?branch=main

package/include/stdlib/math/base/special/floor10.h

@@ -0,0 +1,38 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+#ifndef STDLIB_MATH_BASE_SPECIAL_FLOOR10_H
+#define STDLIB_MATH_BASE_SPECIAL_FLOOR10_H
+
+/*
+* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
+*/
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+* Rounds a numeric value to the nearest power of `10` toward negative infinity.
+*/
+double stdlib_base_floor10( const double x );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // !STDLIB_MATH_BASE_SPECIAL_FLOOR10_H

package/lib/native.js

@@ -0,0 +1,54 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var addon = require( './../src/addon.node' );
+
+
+// MAIN //
+
+/**
+* Rounds a numeric value to the nearest power of `10` toward negative infinity.
+*
+* @private
+* @param {number} x - input value
+* @returns {number} rounded value
+*
+* @example
+* var v = floor10( 3.141592653589793 );
+* // returns 1.0
+*
+* @example
+* var v = floor10( 9.0 );
+* // returns 1.0
+*
+* @example
+* var v = floor10( -0.314 );
+* // returns -1.0
+*/
+function floor10( x ) {
+	return addon( x );
+}
+
+
+// EXPORTS //
+
+module.exports = floor10;

package/manifest.json

@@ -0,0 +1,102 @@
+{
+  "options": {
+    "task": "build"
+  },
+  "fields": [
+    {
+      "field": "src",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "include",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "libraries",
+      "resolve": false,
+      "relative": false
+    },
+    {
+      "field": "libpath",
+      "resolve": true,
+      "relative": false
+    }
+  ],
+  "confs": [
+    {
+      "task": "build",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [
+        "-lm"
+      ],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-napi-unary",
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-assert-is-infinite",
+        "@stdlib/math-base-special-pow",
+        "@stdlib/math-base-special-floor",
+        "@stdlib/math-base-special-ceil",
+        "@stdlib/math-base-special-log10",
+        "@stdlib/constants-float64-max-base10-exponent",
+        "@stdlib/constants-float64-min-base10-exponent-subnormal",
+        "@stdlib/constants-float64-ninf"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [
+        "-lm"
+      ],
+      "libpath": [],
+      "dependencies": [
+       "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-assert-is-infinite",
+        "@stdlib/math-base-special-pow",
+        "@stdlib/math-base-special-floor",
+        "@stdlib/math-base-special-ceil",
+        "@stdlib/math-base-special-log10",
+        "@stdlib/constants-float64-max-base10-exponent",
+        "@stdlib/constants-float64-min-base10-exponent-subnormal",
+        "@stdlib/constants-float64-ninf"
+      ]
+    },
+    {
+      "task": "examples",
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [
+        "-lm"
+      ],
+      "libpath": [],
+      "dependencies": [
+       "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-assert-is-infinite",
+        "@stdlib/math-base-special-pow",
+        "@stdlib/math-base-special-floor",
+        "@stdlib/math-base-special-ceil",
+        "@stdlib/math-base-special-log10",
+        "@stdlib/constants-float64-max-base10-exponent",
+        "@stdlib/constants-float64-min-base10-exponent-subnormal",
+        "@stdlib/constants-float64-ninf"
+      ]
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/math-base-special-floor10",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Round a numeric value to the nearest power of 10 toward negative infinity.",
   "license": "Apache-2.0",
   "author": {
@@ -14,9 +14,12 @@
     }
   ],
   "main": "./lib",
+  "gypfile": false,
   "directories": {
     "doc": "./docs",
+    "include": "./include",
     "lib": "./lib",
+    "src": "./src",
     "dist": "./dist"
   },
   "types": "./docs/types",
@@ -30,15 +33,17 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/constants-float64-max-base10-exponent": "^0.2.1",
-    "@stdlib/constants-float64-min-base10-exponent-subnormal": "^0.2.0",
-    "@stdlib/constants-float64-ninf": "^0.2.1",
-    "@stdlib/math-base-assert-is-infinite": "^0.2.1",
-    "@stdlib/math-base-assert-is-nan": "^0.2.1",
-    "@stdlib/math-base-special-ceil": "^0.2.1",
-    "@stdlib/math-base-special-floor": "^0.2.1",
-    "@stdlib/math-base-special-log10": "^0.2.1",
-    "@stdlib/math-base-special-pow": "^0.2.1"
+    "@stdlib/constants-float64-max-base10-exponent": "^0.2.2",
+    "@stdlib/constants-float64-min-base10-exponent-subnormal": "^0.2.1",
+    "@stdlib/constants-float64-ninf": "^0.2.2",
+    "@stdlib/math-base-assert-is-infinite": "^0.2.2",
+    "@stdlib/math-base-assert-is-nan": "^0.2.2",
+    "@stdlib/math-base-napi-unary": "^0.2.3",
+    "@stdlib/math-base-special-ceil": "^0.2.2",
+    "@stdlib/math-base-special-floor": "^0.2.3",
+    "@stdlib/math-base-special-log10": "^0.3.0",
+    "@stdlib/math-base-special-pow": "^0.3.0",
+    "@stdlib/utils-library-manifest": "^0.2.2"
   },
   "devDependencies": {},
   "engines": {

package/src/addon.c

@@ -0,0 +1,22 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+#include "stdlib/math/base/special/floor10.h"
+#include "stdlib/math/base/napi/unary.h"
+
+STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_floor10 )

package/src/main.c

@@ -0,0 +1,76 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+#include "stdlib/math/base/special/floor10.h"
+#include "stdlib/math/base/assert/is_nan.h"
+#include "stdlib/math/base/assert/is_infinite.h"
+#include "stdlib/math/base/special/pow.h"
+#include "stdlib/math/base/special/floor.h"
+#include "stdlib/math/base/special/ceil.h"
+#include "stdlib/math/base/special/log10.h"
+#include "stdlib/constants/float64/max_base10_exponent.h"
+#include "stdlib/constants/float64/min_base10_exponent_subnormal.h"
+#include "stdlib/constants/float64/ninf.h"
+
+/**
+* Rounds a numeric value to the nearest power of `10` toward negative infinity.
+*
+* @param x    input value
+* @return     rounded value
+*
+* @example
+* double y = stdlib_base_floor10( 3.141592653589793 );
+* // returns 1.0
+*/
+double stdlib_base_floor10( const double x ) {
+	double sign;
+	double xc;
+	double p;
+
+	if ( stdlib_base_is_nan( x ) || stdlib_base_is_infinite( x ) || x == 0.0 ) {
+		return x;
+	}
+	xc = x;
+	if ( x < 0 ) {
+		xc = -xc;
+		sign = -1.0;
+	} else {
+		sign = 1.0;
+	}
+
+	// Solve the equation `10^p = x` for `p`:
+	p = stdlib_base_log10( xc );
+
+	// Determine a power of `10` which rounds the input value toward negative infinity:
+	if ( sign == 1.0 ) {
+		p = stdlib_base_floor( p );
+	} else {
+		p = stdlib_base_ceil( p );
+	}
+
+	// Handle underflow:
+	if ( p <= STDLIB_CONSTANT_FLOAT64_MIN_BASE10_EXPONENT_SUBNORMAL ) {
+		return sign * 0.0; // sign-preserving
+	}
+
+	// Handle overflow:
+	if ( p > STDLIB_CONSTANT_FLOAT64_MAX_BASE10_EXPONENT ) {
+		return STDLIB_CONSTANT_FLOAT64_NINF;
+	}
+	return sign * stdlib_base_pow( 10.0, p );
+}