@stdlib/math-base-special-copysignf 0.0.1

package/README.md

@@ -0,0 +1,277 @@
+<!--
+
+@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.
+
+-->
+
+# copysignf
+
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
+
+> Return a [single-precision floating-point number][ieee754] with the magnitude of `x` and the sign of `y`.
+
+<section class="installation">
+
+## Installation
+
+```bash
+npm install @stdlib/math-base-special-copysignf
+```
+
+</section>
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var copysignf = require( '@stdlib/math-base-special-copysignf' );
+```
+
+#### copysignf( x, y )
+
+Returns a [single-precision floating-point number][ieee754] with the magnitude of `x` and the sign of `y`.
+
+```javascript
+var z = copysignf( -3.0, 10.0 );
+// returns 3.0
+
+z = copysignf( 3.0, -1.0 );
+// returns -3.0
+
+z = copysignf( 1.0, -0.0 );
+// returns -1.0
+
+z = copysignf( -3.0, -0.0 );
+// returns -3.0
+
+z = copysignf( -0.0, 1.0 );
+// returns 0.0
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   According to the [IEEE754][ieee754] standard, a `NaN` has a biased exponent equal to `255`, a significand greater than `0`, and a sign bit equal to **either** `1` **or** `0`. In which case, `NaN` may not correspond to just one but many binary representations. Accordingly, care should be taken to ensure that `y` is **not** `NaN`; otherwise, behavior may be indeterminate.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random-base-randu' );
+var copysignf = require( '@stdlib/math-base-special-copysignf' );
+
+var x;
+var y;
+var z;
+var i;
+
+// Generate random numbers `x` and `y` and copy the sign of `y` to `x`...
+for ( i = 0; i < 100; i++ ) {
+    x = (randu()*100.0) - 50.0;
+    y = (randu()*10.0) - 5.0;
+    z = copysignf( x, y );
+    console.log( 'x: %d, y: %d => %d', x, y, z );
+}
+```
+
+</section>
+
+<!-- /.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/copysignf.h"
+```
+
+#### stdlib_base_copysignf( x, y )
+
+Returns a [single-precision floating-point number][ieee754] with the magnitude of `x` and the sign of `y`.
+
+```c
+float v = stdlib_base_copysignf( -3.0f, 10.0f );
+// returns 3.0f
+
+float v = stdlib_base_copysignf( 3.0f, -1.0f );
+// returns -3.0f
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] float` number from which to derive a magnitude.
+-   **y**: `[in] float` number from which to derive a sign.
+
+```c
+float stdlib_base_copysignf( const float x, const float y );
+```
+
+</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/copysignf.h"
+#include <stdio.h>
+
+int main() {
+    float x[] = { 3.0f, -3.0f, 0.0f, 0.0f/0.0f };
+
+    float y;
+    int i;
+    for ( i = 0; i < 4; i++ ) {
+        y = stdlib_base_copysignf( x[ i ], -3.0f );
+        printf( "copysignf(%f, %f) = %f\n", x[ i ], -3.0f, y );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+
+<section class="main-repo" >
+
+* * *
+
+## Notice
+
+This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
+
+For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
+
+#### Community
+
+[![Chat][chat-image]][chat-url]
+
+---
+
+## License
+
+See [LICENSE][stdlib-license].
+
+
+## Copyright
+
+Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+
+</section>
+
+<!-- /.stdlib -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-copysignf.svg
+[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-copysignf
+
+[test-image]: https://github.com/stdlib-js/math-base-special-copysignf/actions/workflows/test.yml/badge.svg
+[test-url]: https://github.com/stdlib-js/math-base-special-copysignf/actions/workflows/test.yml
+
+[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-copysignf/main.svg
+[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-copysignf?branch=main
+
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/math-base-special-copysignf.svg
+[dependencies-url]: https://david-dm.org/stdlib-js/math-base-special-copysignf/main
+
+-->
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/math-base-special-copysignf/tree/deno
+[umd-url]: https://github.com/stdlib-js/math-base-special-copysignf/tree/umd
+[esm-url]: https://github.com/stdlib-js/math-base-special-copysignf/tree/esm
+
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://gitter.im/stdlib-js/stdlib/
+
+[stdlib]: https://github.com/stdlib-js/stdlib
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-copysignf/main/LICENSE
+
+[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
+
+</section>
+
+<!-- /.links -->

package/docs/repl.txt

@@ -0,0 +1,34 @@
+
+{{alias}}( x, y )
+    Returns a single-precision floating-point number with the magnitude of `x`
+    and the sign of `y`.
+
+    Parameters
+    ----------
+    x: number
+        Number from which to derive a magnitude.
+
+    y: number
+        Number from which to derive a sign.
+
+    Returns
+    -------
+    z: number
+        Single-precision floating-point number.
+
+    Examples
+    --------
+    > var z = {{alias}}( -3.0, 10.0 )
+    3.0
+    > z = {{alias}}( 3.0, -1.0 )
+    -3.0
+    > z = {{alias}}( 1.0, -0.0 )
+    -1.0
+    > z = {{alias}}( -3.0, -0.0 )
+    -3.0
+    > z = {{alias}}( -0.0, 1.0 )
+    0.0
+
+    See Also
+    --------
+

package/docs/types/index.d.ts

@@ -0,0 +1,53 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* 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
+* @returns 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
+*/
+declare function copysignf( x: number, y: number ): number;
+
+
+// EXPORTS //
+
+export = copysignf;

package/docs/types/test.ts

@@ -0,0 +1,57 @@
+/*
+* @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.
+*/
+
+import copysignf = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	copysignf( -3.14, 10 ); // $ExpectType number
+	copysignf( 3.14, -10 ); // $ExpectType number
+}
+
+// The function does not compile if provided values other than two numbers...
+{
+	copysignf( true, 3 ); // $ExpectError
+	copysignf( false, 2 ); // $ExpectError
+	copysignf( '5', 1 ); // $ExpectError
+	copysignf( [], 1 ); // $ExpectError
+	copysignf( {}, 2 ); // $ExpectError
+	copysignf( ( x: number ): number => x, 2 ); // $ExpectError
+
+	copysignf( -9, true ); // $ExpectError
+	copysignf( -9, false ); // $ExpectError
+	copysignf( -5, '5' ); // $ExpectError
+	copysignf( -8, [] ); // $ExpectError
+	copysignf( -9, {} ); // $ExpectError
+	copysignf( -8, ( x: number ): number => x ); // $ExpectError
+
+	copysignf( [], true ); // $ExpectError
+	copysignf( {}, false ); // $ExpectError
+	copysignf( false, '5' ); // $ExpectError
+	copysignf( {}, [] ); // $ExpectError
+	copysignf( '5', ( x: number ): number => x ); // $ExpectError
+}
+
+// The function does not compile if provided insufficient arguments...
+{
+	copysignf(); // $ExpectError
+	copysignf( -3 ); // $ExpectError
+}

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

@@ -0,0 +1,38 @@
+/**
+* @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.
+*/
+
+#ifndef STDLIB_MATH_BASE_SPECIAL_COPYSIGNF_H
+#define STDLIB_MATH_BASE_SPECIAL_COPYSIGNF_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
+
+/**
+* Returns a single-precision floating-point number with the magnitude of `x` and the sign of `y`.
+*/
+float stdlib_base_copysignf( const float x, const float y );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // !STDLIB_MATH_BASE_SPECIAL_COPYSIGNF_H

package/include.gypi

@@ -0,0 +1,53 @@
+# @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.
+
+# A GYP include file for building a Node.js native add-on.
+#
+# Main documentation:
+#
+# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
+# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
+{
+  # Define variables to be used throughout the configuration for all targets:
+  'variables': {
+    # Source directory:
+    'src_dir': './src',
+
+    # Include directories:
+    'include_dirs': [
+      '<!@(node -e "var arr = require(\'@stdlib/utils-library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).include; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")',
+    ],
+
+    # Add-on destination directory:
+    'addon_output_dir': './src',
+
+    # Source files:
+    'src_files': [
+      '<(src_dir)/addon.c',
+      '<!@(node -e "var arr = require(\'@stdlib/utils-library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).src; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")',
+    ],
+
+    # Library dependencies:
+    'libraries': [
+      '<!@(node -e "var arr = require(\'@stdlib/utils-library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).libraries; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")',
+    ],
+
+    # Library directories:
+    'library_dirs': [
+      '<!@(node -e "var arr = require(\'@stdlib/utils-library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).libpath; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")',
+    ],
+  }, # end variables
+}

package/lib/index.js

@@ -0,0 +1,52 @@
+/**
+* @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';
+
+/**
+* Return a single-precision floating-point number with the magnitude of `x` and the sign of `y`.
+*
+* @module @stdlib/math-base-special-copysignf
+*
+* @example
+* var copysignf = require( '@stdlib/math-base-special-copysignf' );
+*
+* var z = copysignf( -3.0, 10.0 );
+* // returns 3.0
+*
+* z = copysignf( 3.0, -1.0 );
+* // returns -3.0
+*
+* z = copysignf( 1.0, -0.0 );
+* // returns -1.0
+*
+* z = copysignf( -3.0, -0.0 );
+* // returns -3.0
+*
+* z = copysignf( -0.0, 1.0 );
+* // returns 0.0
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/lib/main.js

@@ -0,0 +1,95 @@
+/**
+* @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 float64ToFloat32 = require( '@stdlib/number-float64-base-to-float32' );
+var toWord = require( '@stdlib/number-float32-base-to-word' );
+var fromWord = require( '@stdlib/number-float32-base-from-word' );
+
+
+// VARIABLES //
+
+// 10000000000000000000000000000000 => 2147483648 => 0x80000000
+var SIGN_MASK = 0x80000000>>>0; // asm type annotation
+
+// 01111111111111111111111111111111 => 2147483647 => 0x7fffffff
+var MAGNITUDE_MASK = 0x7fffffff|0; // asm type annotation
+
+
+// MAIN //
+
+/**
+* Returns a single-precision floating-point number with the magnitude of `x` and the sign of `y`.
+*
+* @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 ) {
+	var wx;
+	var wy;
+
+	x = float64ToFloat32( x );
+	y = float64ToFloat32( y );
+
+	// Convert `x` to an unsigned integer:
+	wx = toWord( x );
+
+	// Turn off the sign bit of `x`:
+	wx &= MAGNITUDE_MASK;
+
+	// Convert `y` to an unsigned integer:
+	wy = toWord( y );
+
+	// 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`:
+	return fromWord( wx );
+}
+
+
+// EXPORTS //
+
+module.exports = copysignf;