@stdlib/math-base-special-copysignf 0.0.1

package/lib/native.js

@@ -0,0 +1,63 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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 //
+
+/**
+* Returns a single-precision floating-point number with the magnitude of `x` and the sign of `y`.
+*
+* @private
+* @param {number} x - number from which to derive a magnitude
+* @param {number} y - number from which to derive a sign
+* @returns {number} a single-precision floating-point number
+*
+* @example
+* var z = copysignf( -3.0, 10.0 );
+* // returns 3.0
+*
+* @example
+* var z = copysignf( 3.0, -1.0 );
+* // returns -3.0
+*
+* @example
+* var z = copysignf( 1.0, -0.0 );
+* // returns -1.0
+*
+* @example
+* var z = copysignf( -3.0, -0.0 );
+* // returns -3.0
+*
+* @example
+* var z = copysignf( -0.0, 1.0 );
+* // returns 0.0
+*/
+function copysignf( x, y ) {
+	return addon( x, y );
+}
+
+
+// EXPORTS //
+
+module.exports = copysignf;

package/manifest.json

@@ -0,0 +1,81 @@
+{
+	"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-binary",
+        "@stdlib/number-float32-base-to-word",
+        "@stdlib/number-float32-base-from-word"
+			]
+		},
+		{
+			"task": "benchmark",
+			"src": [
+				"./src/main.c"
+			],
+			"include": [
+				"./include"
+			],
+			"libraries": [
+				"-lm"
+			],
+			"libpath": [],
+			"dependencies": [
+        "@stdlib/number-float32-base-to-word",
+        "@stdlib/number-float32-base-from-word"
+			]
+		},
+		{
+			"task": "examples",
+			"src": [
+				"./src/main.c"
+			],
+			"include": [
+				"./include"
+			],
+			"libraries": [
+				"-lm"
+			],
+			"libpath": [],
+			"dependencies": [
+        "@stdlib/number-float32-base-to-word",
+        "@stdlib/number-float32-base-from-word"
+			]
+		}
+	]
+}

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "@stdlib/math-base-special-copysignf",
+  "version": "0.0.1",
+  "description": "Return a single-precision floating-point number with the magnitude of x and the sign of y.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "gypfile": false,
+  "directories": {
+    "benchmark": "./benchmark",
+    "doc": "./docs",
+    "example": "./examples",
+    "include": "./include",
+    "lib": "./lib",
+    "src": "./src",
+    "test": "./test"
+  },
+  "types": "./docs/types",
+  "scripts": {
+    "test": "make test",
+    "test-cov": "make test-cov",
+    "examples": "make examples",
+    "benchmark": "make benchmark"
+  },
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/math-base-special-copysignf.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/math-base-napi-binary": "^0.0.x",
+    "@stdlib/number-float32-base-from-word": "^0.0.x",
+    "@stdlib/number-float32-base-to-word": "^0.0.x",
+    "@stdlib/number-float64-base-to-float32": "^0.0.x",
+    "@stdlib/utils-library-manifest": "^0.0.x"
+  },
+  "devDependencies": {
+    "@stdlib/bench": "^0.0.x",
+    "@stdlib/constants-float32-ninf": "^0.0.x",
+    "@stdlib/constants-float32-pinf": "^0.0.x",
+    "@stdlib/math-base-assert-is-nanf": "^0.0.x",
+    "@stdlib/math-base-assert-is-negative-zerof": "^0.0.x",
+    "@stdlib/math-base-assert-is-positive-zerof": "^0.0.x",
+    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/utils-try-require": "^0.0.x",
+    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
+    "istanbul": "^0.4.1",
+    "tap-spec": "5.x.x"
+  },
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdmath",
+    "math",
+    "mathematics",
+    "float32",
+    "float",
+    "floating-point",
+    "ieee754",
+    "copysignf",
+    "copy",
+    "sign",
+    "bits",
+    "number",
+    "flt",
+    "special",
+    "function"
+  ],
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/athan"
+  }
+}

package/src/addon.c

@@ -0,0 +1,23 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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/copysignf.h"
+#include "stdlib/math/base/napi/binary.h"
+
+// cppcheck-suppress shadowFunction
+STDLIB_MATH_BASE_NAPI_MODULE_FF_F( stdlib_base_copysignf )

package/src/main.c

@@ -0,0 +1,68 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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/copysignf.h"
+#include "stdlib/number/float32/base/to_word.h"
+#include "stdlib/number/float32/base/from_word.h"
+#include <stdint.h>
+
+// 10000000000000000000000000000000 => 2147483648 => 0x80000000
+static const uint32_t SIGN_MASK = 0x80000000;
+
+// 01111111111111111111111111111111 => 2147483647 => 0x7fffffff
+static const int32_t MAGNITUDE_MASK = 0x7fffffff;
+
+/**
+* Returns a single-precision floating-point number with the magnitude of `x` and the sign of `y`.
+*
+* @param x       number from which to derive a magnitude
+* @param y       number from which to derive a sign
+* @return        result
+*
+* @example
+* float v = stdlib_base_copysignf( -3.0f, 10.0f );
+* // returns 3.0f
+*
+* @example
+* float v = stdlib_base_copysignf( 3.0f, -1.0f );
+* // returns -3.0f
+*/
+float stdlib_base_copysignf( const float x, const float y ) {
+	uint32_t wx;
+	uint32_t wy;
+	float z;
+
+	// Convert `x` to an unsigned integer:
+	stdlib_base_float32_to_word( x, &wx );
+
+	// Turn off the sign bit of `x`:
+	wx &= MAGNITUDE_MASK;
+
+	// Convert `y` to an unsigned integer:
+	stdlib_base_float32_to_word( y, &wy );
+
+	// Leave only the sign bit of `y` turned on:
+	wy &= SIGN_MASK;
+
+	// Copy the sign bit of `y` to `x`:
+	wx |= wy;
+
+	// Return a new value having the same magnitude as `x`, but with the sign of `y`:
+	stdlib_base_float32_from_word( wx, &z );
+	return z;
+}