Skip to content
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

feat: add C implementation for math/base/special/max #1459

Merged
merged 30 commits into from
Mar 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
10b24bf
feat: Add C implementation for @stdlib/math/base/special/max
Shashankss1205 Mar 2, 2024
3b13624
Update README.md
Shashankss1205 Mar 3, 2024
558a5e8
Update README.md
Shashankss1205 Mar 3, 2024
ad72477
fix: requested changes made for #1459
Shashankss1205 Mar 3, 2024
7ca9907
fix: requested changes made for #1459
Shashankss1205 Mar 3, 2024
215caf6
fix: requested changes made for #1459
Shashankss1205 Mar 3, 2024
339177b
fix: requested changes made for #1459
Shashankss1205 Mar 3, 2024
ec098db
Update README.md
Shashankss1205 Mar 3, 2024
082e63c
Update Makefile
Shashankss1205 Mar 3, 2024
7eea6e5
Rename addone.c to addon.c
Shashankss1205 Mar 3, 2024
29c24e6
Update main.c
Shashankss1205 Mar 3, 2024
b9ecae8
Merge branch 'stdlib-js:develop' into debug2
Shashankss1205 Mar 4, 2024
1523e4e
Merge branch 'stdlib-js:develop' into debug2
Shashankss1205 Mar 5, 2024
5b260f9
fix: add C implementation for @stdlib/math/base/assert/max
Shashankss1205 Mar 5, 2024
d23210d
fix: add C implementation for @stdlib/math/base/assert/max
Shashankss1205 Mar 5, 2024
12df0eb
fix: add C implementation for @stdlib/math/base/assert/max
Shashankss1205 Mar 5, 2024
580d98d
fix: add C implementation for @stdlib/math/base/assert/max
Shashankss1205 Mar 5, 2024
d21df59
Merge branch 'stdlib-js:develop' into debug2
Shashankss1205 Mar 9, 2024
b2297da
fix: new line added at the end of each file
Shashankss1205 Mar 9, 2024
38b22bf
fix: new line added at the end of each file
Shashankss1205 Mar 9, 2024
6edc185
fix: new line added at the end of each file
Shashankss1205 Mar 9, 2024
6ffaa62
fix: new line added at the end of each file
Shashankss1205 Mar 9, 2024
3547778
fix: new line added at the end of each file
Shashankss1205 Mar 9, 2024
8cb91f2
fix: new line added at the end of each file
Shashankss1205 Mar 9, 2024
0c9382d
fix: new line added at the end of each file
Shashankss1205 Mar 9, 2024
874cf69
fix: new line added at the end of each file
Shashankss1205 Mar 9, 2024
d01fa73
fix: new line added at the end of each file
Shashankss1205 Mar 9, 2024
9d9064b
Merge branch 'debug2' of https://github.com/Shashankss1205/stdlib int…
Shashankss1205 Mar 9, 2024
d90b327
Update lib/node_modules/@stdlib/math/base/special/max/src/main.c
Planeshifter Mar 10, 2024
dfd9a22
Update lib/node_modules/@stdlib/math/base/special/max/src/main.c
Planeshifter Mar 10, 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
93 changes: 93 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/max/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,99 @@ 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/max.h"
```

#### stdlib_base_max( x, y )

Returns the maximum value.

```c
double out = stdlib_base_max( 4.2, 3.14 );
// returns 4.2

out = stdlib_base_max( 0.0, -0.0 );
// returns 0.0
```

The function accepts the following arguments:

- **x**: `[in] double` input value.
- **y**: `[in] double` input value.

```c
double stdlib_base_max( const double x, const double 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/max.h"
#include <stdlib.h>
#include <stdio.h>

int main( void ) {
double x;
double y;
double v;
int i;

for ( i = 0; i < 100; i++ ) {
x = ( ( (double)rand() / (double)RAND_MAX ) * 200.0 ) - 100.0;
y = ( ( (double)rand() / (double)RAND_MAX ) * 200.0 ) - 100.0;
v = stdlib_base_max( x, y );
printf( "x: %lf, y: %lf, max(x, y): %lf\n", x, y, v );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/**
* @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 isnan = require( '@stdlib/math/base/assert/is-nan' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

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


// MAIN //

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

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*200.0 ) - 100.0;
y = ( randu()*200.0 ) - 100.0;
z = max( x, y );
if ( isnan( z ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( z ) ) {
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) 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 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
Loading