Skip to content

Conversation

@gururaj1512
Copy link
Member

Resolves None.

Description

What is the purpose of this pull request?

This pull request:

  • feat: add number/float16/base/from-word

Related Issues

Does this pull request have any related issues?

This pull request has the following 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.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

{{TODO: add disclosure if applicable}}


@stdlib-js/reviewers

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
Copilot AI review requested due to automatic review settings December 3, 2025 09:01
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Dec 3, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 3, 2025

Coverage Report

Package Statements Branches Functions Lines
number/float16/base/from-word $\color{green}148/148$
$\color{green}+0.00%$
$\color{green}16/16$
$\color{green}+0.00%$
$\color{green}1/1$
$\color{green}+0.00%$
$\color{green}148/148$
$\color{green}+0.00%$

The above coverage report was generated for the changes in this PR.

@gururaj1512
Copy link
Member Author

/stdlib update-copyright-years

@stdlib-bot stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Dec 3, 2025
@stdlib-bot stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Dec 3, 2025
@kgryte kgryte added Feature Issue or pull request for adding a new feature. and removed Needs Review A pull request which needs code review. labels Dec 3, 2025
var MANTISSA_MASK = 0x03FF; // 0x03FF = 1023 => 0 00000 1111111111

var NUM_MANTISSA_BITS = 10; // Number of mantissa bits in float16
var MAX_EXPONENT = 31; // Maximum exponent value
Copy link
Member

Choose a reason for hiding this comment

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

A couple of follow-up PRs: similar to constants/float64 and constants/float32, we should move these constants to standalone packages in the constants/float16 namespace.

Copy link
Member Author

Choose a reason for hiding this comment

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

I couldn't find any constant similar to MAX_EXPONENT. Do something similar exist in constants/float[32/64] or should I create it with name constants/float16/max-exponent

Copy link
Member

Choose a reason for hiding this comment

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

See the max-base(10|2)-exponent packages.

Copy link
Member

Choose a reason for hiding this comment

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

These are present for both float32 and float64 and may be what you are looking for.

Copy link
Member Author

Choose a reason for hiding this comment

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

The FLOAT16_MAX_BASE2_EXPONENT would return 15

Copy link
Member

Choose a reason for hiding this comment

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

What about the base 10 exponent?

Copy link
Member Author

Choose a reason for hiding this comment

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

base 10 exponent would return 4.
Actually we can take this as

var MAX_EXPONENT = pow( 2, FLOAT16_NUM_EXPONENT_BITS ) - 1; 

Copy link
Member

Choose a reason for hiding this comment

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

Works for me. Although, essentially, 31 = MAX_BASE2_EXPONENT*2 + 1. Not sure if that helps convey the meaning/significance here of 31. I suppose the intent here is what is the value of 11111, which is 31, so your formula works. Although, I would recommend using exp2, rather than pow.

@kgryte kgryte added the Needs Changes Pull request which needs changes before being merged. label Dec 4, 2025
@gururaj1512
Copy link
Member Author

/stdlib merge

@stdlib-bot stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Dec 4, 2025
@stdlib-bot stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Dec 4, 2025
@gururaj1512
Copy link
Member Author

gururaj1512 commented Dec 4, 2025

Need #8771 to be merged first

@kgryte
Copy link
Member

kgryte commented Dec 4, 2025

/stdlib merge

@stdlib-bot stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Dec 4, 2025
Comment on lines +71 to +74
var arr = uniform( 1000, 0.0, MAX_UINT16 );

// Round each number:
var word = map( arr, naryFunction( round, 1 ) );
Copy link
Member

Choose a reason for hiding this comment

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

Would it make more sense to just use random/array/discrete-uniform instead? Then you don't need two separate steps.

@stdlib-bot stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Dec 4, 2025
var y;
var i;

x = uniform( 100, 0.0, MAX_UINT16 );
Copy link
Member

Choose a reason for hiding this comment

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

Same thing regarding discrete-uniform.

var fromWord = require( './../lib' );

// Generate an array of random numbers:
var arr = uniform( 1000, 0.0, MAX_UINT16 );
Copy link
Member

Choose a reason for hiding this comment

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

Same comment as README.

return 0.0;
}
// Subnormal number: (-1)^sign × 2^(-14) × (0.mantissa)
f16 = pow( 2.0, SUBNORMAL_EXPONENT ) * ( mantissa / 1024.0 );
Copy link
Member

Choose a reason for hiding this comment

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

Instead of pow( 2.0, exponent ), I suggest using exp2 which is specifically tailored to 2^exp operations.

Ref: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/exp2

Copy link
Member

Choose a reason for hiding this comment

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

Applies here and below.

// VARIABLES //

var MAX_EXPONENT = 31; // Maximum exponent value
var SUBNORMAL_EXPONENT = 1 - FLOAT16_EXPONENT_BIAS; // Minimum exponent for subnormal numbers
Copy link
Member

Choose a reason for hiding this comment

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

I believe we have an equivalent constant in float32/float64 for this, correct? Meaning, is this another opportunity to move into a separate package?


// VARIABLES //

var MAX_EXPONENT = 31; // Maximum exponent value
Copy link
Member

Choose a reason for hiding this comment

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

As discussed elsewhere, this can become exp2( num_exponent_bits ) - 1.

Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Feature Issue or pull request for adding a new feature. Needs Changes Pull request which needs changes before being merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants