feat: add `math/base/special/lnf` #2315

gunjjoshi · 2024-06-07T17:23:12Z

Description

What is the purpose of this pull request?

This pull request:

adds math/base/special/lnf, which is the single-precision version for math/base/special/ln.

float stdlib_base_lnf( const float x )

I have referred the FreeBSD implementation for logf: https://svnweb.freebsd.org/base/release/12.2.0/lib/msun/src/e_logf.c?revision=367086&view=markup

Related Issues

Does this pull request have any related issues?

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c

Planeshifter

Thanks @gunjjoshi for this PR! Looked all good to me, except for a few if-blocks which should be safe to remove.

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: GUNJ JOSHI <gunjjoshi8372@gmail.com>

Signed-off-by: GUNJ JOSHI <gunjjoshi8372@gmail.com>

kgryte · 2024-06-10T14:21:34Z

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

+
+var toWordf = require( '@stdlib/number/float32/base/to-word' );
+var fromWordf = require( '@stdlib/number/float32/base/from-word' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );


Single-precision so use is-nanf.

kgryte · 2024-06-10T14:23:19Z

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

+
+	// x < 2**-126
+	if ( ix < 0x00800000 ) {
+		k = float64ToFloat32( k - 25 );


k is an integer value and does not need float32 emulation. In C, k is int32?

Yes, it is int32 in C.

kgryte · 2024-06-10T14:23:58Z

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

+	}
+	k = float64ToFloat32( k + float64ToFloat32( ( ix >> 23 ) - FLOAT32_EXPONENT_BIAS ) ); // eslint-disable-line max-len
+	ix &= FLOAT32_SIGNIFICAND_MASK;
+	i = float64ToFloat32( ix + ( 0x95f64 << 3 ) ) & 0x800000;


i also doesn't need float32 emulation based on my reading.

kgryte · 2024-06-10T14:25:00Z

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

+			if ( k === 0 ) {
+				return 0.0;
+			}
+			dk = k;


Here, int32 k is being cast to double in the C implementation. We prob don't need this assignment in the JS version.

kgryte · 2024-06-10T14:31:26Z

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

+		if ( k === 0 ) {
+			return float64ToFloat32( f - R );
+		}
+		dk = k;


Same comment. dk assignment is not necessary.

kgryte · 2024-06-10T14:31:40Z

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

+		return float64ToFloat32( float64ToFloat32( dk * LN2_HI ) - float64ToFloat32( float64ToFloat32( R - float64ToFloat32( dk * LN2_LO ) ) - f ) ); // eslint-disable-line max-len
+	}
+	s = float64ToFloat32( f / float64ToFloat32( 2.0 + f ) );
+	dk = k;


Same comment

kgryte · 2024-06-10T14:31:50Z

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

+	s = float64ToFloat32( f / float64ToFloat32( 2.0 + f ) );
+	dk = k;
+	z = float64ToFloat32( s * s );
+	i = float64ToFloat32( ix - ( 0x6147a << 3 ) );


Same comment

kgryte · 2024-06-10T14:32:03Z

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

+	z = float64ToFloat32( s * s );
+	i = float64ToFloat32( ix - ( 0x6147a << 3 ) );
+	w = float64ToFloat32( z * z );
+	j = float64ToFloat32( ( 0x6b851 << 3 ) - ix );


Same comment.

kgryte · 2024-06-10T14:32:57Z

lib/node_modules/@stdlib/math/base/special/lnf/manifest.json

+        "@stdlib/math/base/napi/unary",
+        "@stdlib/number/float32/base/to-word",
+        "@stdlib/number/float32/base/from-word",
+        "@stdlib/math/base/assert/is-nan",


is-nanf here and below

kgryte · 2024-06-10T14:35:37Z

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c

+		if ( k == 0 ) {
+			return ( f - R );
+		}
+		dk = k;


Same comment.

kgryte · 2024-06-10T14:35:58Z

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c

+		return ( ( dk * LN2_HI ) - ( ( R - ( dk * LN2_LO ) ) - f ) );
+	}
+	s = ( f / ( 2.0f + f ) );
+	dk = k;


Same comment

kgryte · 2024-06-10T14:36:38Z

lib/node_modules/@stdlib/math/base/special/lnf/test/test.js

+// MODULES //
+
+var tape = require( 'tape' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );


kgryte · 2024-06-10T14:37:53Z

lib/node_modules/@stdlib/math/base/special/lnf/test/test.js

+			t.equal( y, e, 'x: '+x[i]+', y: '+y+', expected: '+e );
+		} else {
+			delta = abs( y - e );
+			tol = 75.0 * EPS * abs( e );


This is a bit large. What is the delta of the double-precision variant for subnormals?

kgryte · 2024-06-10T14:38:39Z

lib/node_modules/@stdlib/math/base/special/lnf/test/test.native.js

+
+var resolve = require( 'path' ).resolve;
+var tape = require( 'tape' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );


Same comments.

gunjjoshi · 2024-06-10T17:41:31Z

@kgryte I've made a PR incorporating these changes at #2356.

PR-URL: #2356 Ref: #2315 Reviewed-by: Athan Reines <kgryte@gmail.com>

PR-URL: stdlib-js#2315 --------- Signed-off-by: GUNJ JOSHI <gunjjoshi8372@gmail.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>

PR-URL: stdlib-js#2356 Ref: stdlib-js#2315 Reviewed-by: Athan Reines <kgryte@gmail.com>

PR-URL: stdlib-js#2315 --------- Signed-off-by: GUNJ JOSHI <gunjjoshi8372@gmail.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>

PR-URL: stdlib-js#2356 Ref: stdlib-js#2315 Reviewed-by: Athan Reines <kgryte@gmail.com>

feat: add math/base/special/lnf

f5e707d

stdlib-bot added the Math Issue or pull request specific to math functionality. label Jun 7, 2024

Planeshifter self-requested a review June 8, 2024 18:42

Planeshifter reviewed Jun 9, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c Show resolved Hide resolved

Planeshifter reviewed Jun 9, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js Outdated Show resolved Hide resolved

Planeshifter reviewed Jun 9, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js Outdated Show resolved Hide resolved

Planeshifter reviewed Jun 9, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c Show resolved Hide resolved

Planeshifter approved these changes Jun 9, 2024

View reviewed changes

kgryte added the Feature Issue or pull request for adding a new feature. label Jun 9, 2024

kgryte reviewed Jun 9, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c Outdated Show resolved Hide resolved

kgryte reviewed Jun 9, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c Outdated Show resolved Hide resolved

Planeshifter reviewed Jun 9, 2024

View reviewed changes

lib/node_modules/@stdlib/math/base/special/lnf/src/main.c Outdated Show resolved Hide resolved

gunjjoshi and others added 6 commits June 10, 2024 08:43

refactor: remove initial checks

7312ed0

Update lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

5eca1a5

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: GUNJ JOSHI <gunjjoshi8372@gmail.com>

Update lib/node_modules/@stdlib/math/base/special/lnf/lib/main.js

93ffdb2

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: GUNJ JOSHI <gunjjoshi8372@gmail.com>

Update lib/node_modules/@stdlib/math/base/special/lnf/src/main.c

7b95414

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: GUNJ JOSHI <gunjjoshi8372@gmail.com>

Update main.c

990fce6

Signed-off-by: GUNJ JOSHI <gunjjoshi8372@gmail.com>

remove FLOAT32_ABS_MASK

4980622

Signed-off-by: GUNJ JOSHI <gunjjoshi8372@gmail.com>

Planeshifter merged commit b6edfd8 into stdlib-js:develop Jun 10, 2024
8 checks passed

kgryte reviewed Jun 10, 2024

View reviewed changes

gunjjoshi deleted the lnf branch June 10, 2024 16:45

gunjjoshi mentioned this pull request Jun 10, 2024

refactor: reduce tolerance, correct castings for math/base/special/lnf #2356

Merged

1 task

kgryte pushed a commit that referenced this pull request Jun 10, 2024

refactor: reduce test tolerance and fix casting

fb04f19

PR-URL: #2356 Ref: #2315 Reviewed-by: Athan Reines <kgryte@gmail.com>

aman-095 pushed a commit to aman-095/stdlib that referenced this pull request Jun 11, 2024

refactor: reduce test tolerance and fix casting

c71fdbb

PR-URL: stdlib-js#2356 Ref: stdlib-js#2315 Reviewed-by: Athan Reines <kgryte@gmail.com>

aman-095 pushed a commit to aman-095/stdlib that referenced this pull request Jun 13, 2024

refactor: reduce test tolerance and fix casting

c22ef36

PR-URL: stdlib-js#2356 Ref: stdlib-js#2315 Reviewed-by: Athan Reines <kgryte@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `math/base/special/lnf` #2315

feat: add `math/base/special/lnf` #2315

gunjjoshi commented Jun 7, 2024 •

edited

Loading

Planeshifter left a comment •

edited

Loading

kgryte Jun 10, 2024

kgryte Jun 10, 2024

gunjjoshi Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

kgryte Jun 10, 2024

gunjjoshi commented Jun 10, 2024

feat: add math/base/special/lnf #2315

feat: add math/base/special/lnf #2315

Conversation

gunjjoshi commented Jun 7, 2024 • edited Loading

Description

Related Issues

Questions

Other

Checklist

Planeshifter left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gunjjoshi commented Jun 10, 2024

feat: add `math/base/special/lnf` #2315

feat: add `math/base/special/lnf` #2315

gunjjoshi commented Jun 7, 2024 •

edited

Loading

Planeshifter left a comment •

edited

Loading