Skip to content
Closed
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
4a76c61
Add C implementation
Planeshifter Nov 15, 2022
23e9a28
Scaffold number/float32/base/signbit package files
stdlib-bot Nov 15, 2022
0bf0939
Delete files
Planeshifter Nov 15, 2022
0b7c141
Scaffold number/float32/base/signbit package files
stdlib-bot Nov 15, 2022
b6675ab
Delete files
Planeshifter Nov 15, 2022
817c6b5
Scaffold number/float32/base/signbit package files
stdlib-bot Nov 15, 2022
0ac1349
Delete files
Planeshifter Nov 15, 2022
174edb5
Scaffold number/float32/base/signbit package files
stdlib-bot Nov 15, 2022
fca8f55
Delete files
Planeshifter Nov 15, 2022
b22e5a6
Scaffold number/float32/base/signbit package files
stdlib-bot Nov 15, 2022
896734c
Delete files
Planeshifter Nov 15, 2022
8f74c7f
Scaffold number/float32/base/signbit package files
stdlib-bot Nov 15, 2022
986fad0
Delete files
Planeshifter Nov 15, 2022
fc95921
Scaffold number/float32/base/signbit package files
stdlib-bot Nov 15, 2022
6eebd97
Merge branch 'develop' into number/float32/base/signbit
Planeshifter Nov 14, 2024
cc2d883
Merge branch 'develop' into number/float32/base/signbit
stdlib-bot Nov 14, 2024
a3e9d9c
Merge branch 'develop' into number/float32/base/signbit
stdlib-bot Nov 15, 2024
ba25e1c
Merge branch 'develop' into number/float32/base/signbit
stdlib-bot Nov 15, 2024
c5ce46b
Merge branch 'develop' into number/float32/base/signbit
stdlib-bot Nov 16, 2024
0a6f1b0
chore: update copyright years
stdlib-bot Nov 16, 2024
0acfdc9
Merge remote-tracking branch 'upstream/develop' into number/float32/b…
stdlib-bot Dec 19, 2024
45c62ea
fix: resolve lint errors
stdlib-bot Dec 19, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions lib/node_modules/@stdlib/number/float32/base/signbit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,95 @@ 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/number/float32/base/signbit.h"
```

#### stdlib_base_float32_signbit( x )

Returns a `boolean` indicating if the sign bit for a [single-precision floating-point number][ieee754] is on (`true`) or off (`false`).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We cannot rely on JS and C APIs being the same in terms of API signatures.


```c
#include <stdint.h>

bool out = stdlib_base_float32_signbit( -3.14f );
```

The function accepts the following arguments:

- **x**: `[in] float` input value.

```c
bool stdlib_base_float32_signbit( const float 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/number/float32/base/signbit.h"
#include <stdint.h>
#include <stdio.h>
#include <inttypes.h>

int main() {
float x[] = { 4.0f, 0.0f, -0.0f, 1.0f, -1.0f, 3.14f, -3.14f, 1.0e38f, -1.0e38f, 1.0f/0.0f, -1.0f/0.0f, 0.0f/0.0f };

bool out;
int i;
for ( i = 0; i < 12; i++ ) {
out = stdlib_base_float32_signbit( x[ i ] );
printf( "%f => out: %" PRId32 "\n", x[ i ], out );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/**
* @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 resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var signbitf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( signbitf instanceof Error )
};


// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {
var x;
var y;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*1.0e7 ) - 5.0e6;
y = signbitf( toFloat32( x ) );
if ( typeof bool !== 'boolean' ) {
b.fail( 'should return a boolean' );
}
}
b.toc();
if ( !isBoolean( y ) ) {
b.fail( 'should return a boolean' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
#/
# @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.
#/

# VARIABLES #

ifndef VERBOSE
QUIET := @
else
QUIET :=
endif

# Determine the OS ([1][1], [2][2]).
#
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
# [2]: http://stackoverflow.com/a/27776822/2225624
OS ?= $(shell uname)
ifneq (, $(findstring MINGW,$(OS)))
OS := WINNT
else
ifneq (, $(findstring MSYS,$(OS)))
OS := WINNT
else
ifneq (, $(findstring CYGWIN,$(OS)))
OS := WINNT
else
ifneq (, $(findstring Windows_NT,$(OS)))
OS := WINNT
endif
endif
endif
endif

# Define the program used for compiling C source files:
ifdef C_COMPILER
CC := $(C_COMPILER)
else
CC := gcc
endif

# Define the command-line options when compiling C files:
CFLAGS ?= \
-std=c99 \
-O3 \
-Wall \
-pedantic

# Determine whether to generate position independent code ([1][1], [2][2]).
#
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
ifeq ($(OS), WINNT)
fPIC ?=
else
fPIC ?= -fPIC
endif

# List of C targets:
c_targets := benchmark.out


# RULES #

#/
# Compiles C source files.
#
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
# @param {string} [CFLAGS] - C compiler options
# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code (e.g., `-fPIC`)
#
# @example
# make
#
# @example
# make all
#/
all: $(c_targets)

.PHONY: all

#/
# Compiles C source files.
#
# @private
# @param {string} CC - C compiler
# @param {string} CFLAGS - C compiler flags
# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code
#/
$(c_targets): %.out: %.c
$(QUIET) $(CC) $(CFLAGS) $(fPIC) -o $@ $< -lm

#/
# Runs compiled benchmarks.
#
# @example
# make run
#/
run: $(c_targets)
$(QUIET) ./$<

.PHONY: run

#/
# Removes generated files.
#
# @example
# make clean
#/
clean:
$(QUIET) -rm -f *.o *.out

.PHONY: clean
Loading
Loading