Skip to content

feat: add C implementation for math/base/special/roundsd #4438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 25 commits into from
Apr 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
e3753b6
feat: add math/base/special/roundsd
ShabiShett07 Jan 1, 2025
165b47d
chore: update copyright years
stdlib-bot Jan 2, 2025
e703cea
fix: resolve lint errors
stdlib-bot Jan 2, 2025
b977c33
Merge remote-tracking branch 'upstream/develop' into feature/roundsd
stdlib-bot Apr 5, 2025
76f13c5
fix: jsdoc
ShabiShett07 Apr 5, 2025
28139c7
fix: jsdoc to doxygen
ShabiShett07 Apr 5, 2025
70bc4c8
chore: update doxygen
ShabiShett07 Apr 5, 2025
7557c42
chore: add suggestions
ShabiShett07 Apr 5, 2025
4c9ac94
fix: lint error
ShabiShett07 Apr 5, 2025
e07c69a
fix: lint error
ShabiShett07 Apr 5, 2025
34ab377
remove: unused variables
ShabiShett07 Apr 5, 2025
5b3ac40
chore: remove console
ShabiShett07 Apr 6, 2025
4e97f72
Merge remote-tracking branch 'upstream/develop' into feature/roundsd
stdlib-bot Apr 15, 2025
72ccb45
test: update test messages
anandkaranubc Apr 15, 2025
7c2e6b4
bench: move random number generation outside the benchmarking loops
anandkaranubc Apr 15, 2025
860ebb1
docs: fix C script for generating examples
anandkaranubc Apr 15, 2025
d9eefe3
chore: add minor changes
ShabiShett07 Apr 19, 2025
cf8cced
docs: update description
kgryte Apr 19, 2025
5e16e29
docs: fix description
kgryte Apr 19, 2025
fa48133
docs: fix line wrapping
kgryte Apr 19, 2025
0d5ce2a
style: remove TeX and use backticks to be consistent with elsewhere
kgryte Apr 19, 2025
56061f5
docs: fix description
kgryte Apr 19, 2025
7790569
style: use consistent markup
kgryte Apr 19, 2025
4230887
style: use consistent spacing
kgryte Apr 19, 2025
ecf314f
style: add missing space
kgryte Apr 19, 2025
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
91 changes: 89 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/roundsd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# roundsd

> Round a numeric value to the nearest number with `n` significant figures.
> Round a double-precision floating-point number to the nearest value with `n` significant figures.

<section class="usage">

Expand All @@ -32,7 +32,7 @@ var roundsd = require( '@stdlib/math/base/special/roundsd' );

#### roundsd( x, n\[, b] )

Rounds a `numeric` value to the nearest `number` with `n` significant figures.
Rounds a double-precision floating-point number to the nearest value with `n` significant figures.

```javascript
var v = roundsd( 3.141592653589793, 3 );
Expand Down Expand Up @@ -85,6 +85,93 @@ logEachMap( 'x: %0.4f. y: %d. Rounded: %0.4f.', x, 5, roundsd );

<!-- /.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/roundsd.h"
```

#### stdlib_base_roundsd( x, n, b )

Rounds a double-precision floating-point number to the nearest value with `n` significant figures.

```c
double v = stdlib_base_roundsd( 3.141592653589793, 3, 10 );
// returns 3.14
```

The function accepts the following arguments:

- **x**: `[in] double` input value.
- **n**: `[in] int32_t` number of significant figures.
- **b**: `[in] int32_t` base.

```c
double stdlib_base_roundsd( const double x, const int32_t n, const int32_t b );
```

</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/roundsd.h"
#include <stdio.h>

int main( void ) {
const double x[] = { 3.143546, -3.142635, 0.0, 0.0/0.0 };

double y;
int i;
for ( i = 0; i < 4; i++ ) {
y = stdlib_base_roundsd( x[ i ], 2, 10 );
printf( "roundsd(%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">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

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


// MAIN //

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

x = uniform( 100, -5.0e6, 5.0e6 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = roundsd( x[ i%x.length ], 2, 2 );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
#/
# @license Apache-2.0
#
# Copyright (c) 2025 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 includes (e.g., `-I /foo/bar -I /beep/boop/include`):
INCLUDE ?=

# List of source files:
SOURCE_FILES ?=

# List of libraries (e.g., `-lopenblas -lpthread`):
LIBRARIES ?=

# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
LIBPATH ?=

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


# RULES #

#/
# Compiles source files.
#
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
# @param {string} [CFLAGS] - C compiler options
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
# @param {string} [SOURCE_FILES] - list of source files
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
#
# @example
# make
#
# @example
# make all
#/
all: $(c_targets)

.PHONY: all

#/
# Compiles C source files.
#
# @private
# @param {string} CC - C compiler (e.g., `gcc`)
# @param {string} CFLAGS - C compiler options
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
# @param {string} SOURCE_FILES - list of source files
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
#/
$(c_targets): %.out: %.c
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)

#/
# 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