Skip to content

Commit 02aa5ac

Browse files
Neerajpathak07Neerajpathak07
committed
chore: changes from code review
1 parent 08d43a6 commit 02aa5ac

File tree

11 files changed

+301
-19
lines changed

11 files changed

+301
-19
lines changed

‎lib/node_modules/@stdlib/math/base/special/tribonaccif/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Tribonaccif
2222

23-
> Compute the nth [Tribonacci number][tribonacci-number] for [single-precision floating-point number][ieee754].
23+
> Compute the nth [Tribonacci number][tribonacci-number] as a [single-precision floating-point number][ieee754].
2424
2525
<section class="intro">
2626

@@ -70,7 +70,7 @@ var tribonaccif = require( '@stdlib/math/base/special/tribonaccif' );
7070

7171
#### tribonaccif( n )
7272

73-
Computes the nth [Tribonacci number][tribonacci-number] for [single-precision floating-point number][ieee754].
73+
Computes the nth [Tribonacci number][tribonacci-number] as a [single-precision floating-point number][ieee754].
7474

7575
```javascript
7676
var v = tribonaccif( 0 );
@@ -92,7 +92,7 @@ v = tribonaccif( 30 );
9292
If `n > 30`, the function returns `NaN`, as larger [Tribonacci numbers][tribonacci-number] cannot be safely represented in [single-precision floating-point format][ieee754].
9393

9494
```javascript
95-
var v = tribonaccif( 32 );
95+
var v = tribonaccif( 31 );
9696
// returns NaN
9797
```
9898

@@ -173,14 +173,14 @@ for ( i = 0; i < 31; i++ ) {
173173

174174
#### stdlib_base_tribonaccif( n )
175175

176-
Computes the nth [Tribonacci number][tribonacci-number] [single-precision floating-point number][ieee754].
176+
Computes the nth [Tribonacci number][tribonacci-number] as a [single-precision floating-point number][ieee754].
177177

178178
```c
179-
float out = stdlib_base_tribonaccif( 0f );
180-
// returns 0f
179+
float out = stdlib_base_tribonaccif( 0 );
180+
// returns 0
181181

182-
out = stdlib_base_tribonaccif( 1f );
183-
// returns 0f
182+
out = stdlib_base_tribonaccif( 1 );
183+
// returns 0
184184
```
185185

186186
The function accepts the following arguments:

‎lib/node_modules/@stdlib/math/base/special/tribonaccif/benchmark/c/native/Makefile‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2025 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
# VARIABLES #
20+
21+
ifndef VERBOSE
22+
QUIET := @
23+
else
24+
QUIET :=
25+
endif
26+
27+
# Determine the OS ([1][1], [2][2]).
28+
#
29+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
30+
# [2]: http://stackoverflow.com/a/27776822/2225624
31+
OS ?= $(shell uname)
32+
ifneq (, $(findstring MINGW,$(OS)))
33+
OS := WINNT
34+
else
35+
ifneq (, $(findstring MSYS,$(OS)))
36+
OS := WINNT
37+
else
38+
ifneq (, $(findstring CYGWIN,$(OS)))
39+
OS := WINNT
40+
else
41+
ifneq (, $(findstring Windows_NT,$(OS)))
42+
OS := WINNT
43+
endif
44+
endif
45+
endif
46+
endif
47+
48+
# Define the program used for compiling C source files:
49+
ifdef C_COMPILER
50+
CC := $(C_COMPILER)
51+
else
52+
CC := gcc
53+
endif
54+
55+
# Define the command-line options when compiling C files:
56+
CFLAGS ?= \
57+
-std=c99 \
58+
-O3 \
59+
-Wall \
60+
-pedantic
61+
62+
# Determine whether to generate position independent code ([1][1], [2][2]).
63+
#
64+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
65+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
66+
ifeq ($(OS), WINNT)
67+
fPIC ?=
68+
else
69+
fPIC ?= -fPIC
70+
endif
71+
72+
# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
73+
INCLUDE ?=
74+
75+
# List of source files:
76+
SOURCE_FILES ?=
77+
78+
# List of libraries (e.g., `-lopenblas -lpthread`):
79+
LIBRARIES ?=
80+
81+
# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
82+
LIBPATH ?=
83+
84+
# List of C targets:
85+
c_targets := benchmark.out
86+
87+
88+
# RULES #
89+
90+
#/
91+
# Compiles source files.
92+
#
93+
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
94+
# @param {string} [CFLAGS] - C compiler options
95+
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
96+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
97+
# @param {string} [SOURCE_FILES] - list of source files
98+
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
99+
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
100+
#
101+
# @example
102+
# make
103+
#
104+
# @example
105+
# make all
106+
#/
107+
all: $(c_targets)
108+
109+
.PHONY: all
110+
111+
#/
112+
# Compiles C source files.
113+
#
114+
# @private
115+
# @param {string} CC - C compiler (e.g., `gcc`)
116+
# @param {string} CFLAGS - C compiler options
117+
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
118+
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
119+
# @param {string} SOURCE_FILES - list of source files
120+
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
121+
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
122+
#/
123+
$(c_targets): %.out: %.c
124+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)
125+
126+
#/
127+
# Runs compiled benchmarks.
128+
#
129+
# @example
130+
# make run
131+
#/
132+
run: $(c_targets)
133+
$(QUIET) ./$<
134+
135+
.PHONY: run
136+
137+
#/
138+
# Removes generated files.
139+
#
140+
# @example
141+
# make clean
142+
#/
143+
clean:
144+
$(QUIET) -rm -f *.o *.out
145+
146+
.PHONY: clean

‎lib/node_modules/@stdlib/math/base/special/tribonaccif/benchmark/c/native/benchmark.c‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#include "stdlib/math/base/special/tribonaccif.h"
20+
#include <stdlib.h>
21+
#include <stdio.h>
22+
#include <math.h>
23+
#include <time.h>
24+
#include <sys/time.h>
25+
26+
#define NAME "tribonaccif"
27+
#define ITERATIONS 100
28+
#define REPEATS 3
29+
30+
/**
31+
* Prints the TAP version.
32+
*/
33+
static void print_version( void ) {
34+
printf( "TAP version 13\n" );
35+
}
36+
37+
/**
38+
* Prints the TAP summary.
39+
*
40+
* @param total total number of tests
41+
* @param passing total number of passing tests
42+
*/
43+
static void print_summary( int total, int passing ) {
44+
printf( "#\n" );
45+
printf( "1..%d\n", total ); // TAP plan
46+
printf( "# total %d\n", total );
47+
printf( "# pass %d\n", passing );
48+
printf( "#\n" );
49+
printf( "# ok\n" );
50+
}
51+
52+
/**
53+
* Prints benchmarks results.
54+
*
55+
* @param elapsed elapsed time in seconds
56+
*/
57+
static void print_results( double elapsed ) {
58+
double rate = (double)ITERATIONS / elapsed;
59+
printf( " ---\n" );
60+
printf( " iterations: %d\n", ITERATIONS );
61+
printf( " elapsed: %0.9f\n", elapsed );
62+
printf( " rate: %0.9f\n", rate );
63+
printf( " ...\n" );
64+
}
65+
66+
/**
67+
* Returns a clock time.
68+
*
69+
* @return clock time
70+
*/
71+
static double tic( void ) {
72+
struct timeval now;
73+
gettimeofday( &now, NULL );
74+
return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
75+
}
76+
77+
/**
78+
* Generates a random number on the interval [0,1).
79+
*
80+
* @return random number
81+
*/
82+
static float rand_float( void ) {
83+
int r = rand();
84+
return (float)r / ( (float)RAND_MAX + 1.0f );
85+
}
86+
87+
/**
88+
* Runs a benchmark.
89+
*
90+
* @return elapsed time in seconds
91+
*/
92+
static double benchmark( void ) {
93+
int32_t x[ 100 ];
94+
double elapsed;
95+
double t;
96+
float y;
97+
int i;
98+
99+
for ( i = 0; i < 100; i++ ) {
100+
x[ i ] = (int32_t)floorf( 40.0f*rand_float() );
101+
}
102+
103+
t = tic();
104+
for ( i = 0; i < ITERATIONS; i++ ) {
105+
y = stdlib_base_tribonaccif( x[ i%100 ] );
106+
if ( y < 0 ) {
107+
printf( "should return a nonnegative integer\n" );
108+
break;
109+
}
110+
}
111+
elapsed = tic() - t;
112+
if ( y < 0 ) {
113+
printf( "should return a nonnegative integer\n" );
114+
}
115+
return elapsed;
116+
}
117+
118+
/**
119+
* Main execution sequence.
120+
*/
121+
int main( void ) {
122+
double elapsed;
123+
int i;
124+
125+
// Use the current time to seed the random number generator:
126+
srand( time( NULL ) );
127+
128+
print_version();
129+
for ( i = 0; i < REPEATS; i++ ) {
130+
printf( "# c::native::%s\n", NAME );
131+
elapsed = benchmark();
132+
print_results( elapsed );
133+
printf( "ok %d benchmark finished\n", i+1 );
134+
}
135+
print_summary( REPEATS, REPEATS );
136+
}

‎lib/node_modules/@stdlib/math/base/special/tribonaccif/docs/repl.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( n )
3-
Computes the nth Tribonacci number for single-precision floating-point
3+
Computes the nth Tribonacci number as a single-precision floating-point
44
number.
55

66
Tribonacci numbers follow the recurrence relation
@@ -39,7 +39,7 @@
3939
1
4040
> y = {{alias}}( 4 )
4141
2
42-
> y = {{alias}}( 32 )
42+
> y = {{alias}}( 31 )
4343
NaN
4444
> y = {{alias}}( NaN )
4545
NaN

‎lib/node_modules/@stdlib/math/base/special/tribonaccif/docs/types/index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes the nth Tribonacci number for single-precision floating-point number.
22+
* Computes the nth Tribonacci number as a single-precision floating-point number.
2323
*
2424
* ## Notes
2525
*

‎lib/node_modules/@stdlib/math/base/special/tribonaccif/include/stdlib/math/base/special/tribonaccif.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ extern "C" {
2626
#endif
2727

2828
/**
29-
* Computes the nth Tribonacci number for single-precision floating-point number.
29+
* Computes the nth Tribonacci number as a single-precision floating-point number.
3030
*/
3131
float stdlib_base_tribonaccif( const int32_t n );
3232

‎lib/node_modules/@stdlib/math/base/special/tribonaccif/lib/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Compute the nth Tribonacci number for single-precision floating-point number.
22+
* Compute the nth Tribonacci number as a single-precision floating-point number.
2323
*
2424
* @module @stdlib/math/base/special/tribonaccif
2525
*

‎lib/node_modules/@stdlib/math/base/special/tribonaccif/lib/main.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var TRIBONACCIF = require( './tribonaccif.json' );
2929
// MAIN //
3030

3131
/**
32-
* Computes the nth Tribonacci number for single-precision floating-point number.
32+
* Computes the nth Tribonacci number as a single-precision floating-point number.
3333
*
3434
* @param {NonNegativeInteger} n - the Tribonacci number to compute
3535
* @returns {NonNegativeInteger} Tribonacci number

‎lib/node_modules/@stdlib/math/base/special/tribonaccif/lib/native.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Computes the nth Tribonacci number for single-precision floating-point number.
29+
* Computes the nth Tribonacci number as a single-precision floating-point number.
3030
*
3131
* @private
3232
* @param {NonNegativeInteger} n - the Tribonacci number to compute

0 commit comments

Comments
 (0)