feat: new functions in stdlib from `stdlib.fc` and `math.fc` #986

Gusarich · 2024-10-25T05:33:51Z

Issue

Closes #770
Towards #1029 (only myCode())

Checklist

I have updated CHANGELOG.md
I have documented my contribution in docs/ and made the build locally
I have added tests to demonstrate the contribution is correctly implemented: this usually includes both positive and negative tests, showing the happy path(s) and featuring intentionally broken cases
I have run all the tests locally and no test failure was reported
I have run the linter, formatter and spellchecker
I did not do unrelated and/or undiscussed refactorings

Current State

All stdlib.fc functions are present in Tact stdlib in some form, with some exceptions:
- no tuple manipulation functions, because there is no tuple support in Tact. Do we really need them? @anton-trunov
- no minmax and no slice_bits_refs because we don't have tensor types in Tact and it would be useless: Tensor types #1116
- no set_data and get_data because Tact manages persistent storage by itself
- no bless and other continuation functions because Tact manages control flow itself and for running some arbitrary code it's better to use RUNVM which doesn't require continuations parameters
- no raw_reserve_extra because it requires an uint32 -> varuint32 dictionary and we only support varuint16 for values currently: VarUInt32, VarInt16, VarInt32 serialization types #1117
All mathlib.fc functions are present in Tact stdlib in some form, with some exceptions:
- no fixed-point arithmetic related functions: Fixed-point arithmetics library #1118
- no nan and is_nan because we don't support NaN in Tact. Do we really need them? @anton-trunov
- no sub_rev because it is useless in our case
- no ...MOD instructions because they return two values as a tensor and it won't be very developer-friendly in Tact to make them return tuples in my opinion: Tensor types #1116
All new functions are covered with tests

novusnota

Sorry for reviewing the draft, I just wanted to keep those notes around :)

stdlib/stdlib.fc

stdlib/std/math.tact

stdlib/std/cells.tact

Gusarich · 2024-11-18T03:41:38Z

@novusnota @anton-trunov Implemented all functions. I'd like to hear some intermediate feedback on them before I proceed with writing tests.

I made sure to include all missing functions from both stdlib.fc and mathlib.fc with some exceptions (see PR description).

anton-trunov

afair, mathlib.fc has lots of functions for fixed-arithmetic as well, I think we should add those too (perhaps as a separate library, like fixed_point_math.tact).

Also, I left a couple comments in the source code

CHANGELOG.md

anton-trunov · 2024-11-18T07:55:13Z

stdlib/std/cells.tact

+    refs: Int;
+}
+
+asm fun computeDataSize(cell: Cell, maxCells: Int): DataSize { CDATASIZE TRIPLE }


Would TRIPLE work here? Structures are returned as tensors, right?

TRIPLE makes three elements into a tuple of length 3. I think it should work

yes, but our structs are tensors, not tuples, right?

structs are implemented as tuples in Tact (that's why we had problems with long ones in the first place, remember?)

ah, I must have mistaken it with the unbundled approach in the storage

stdlib/std/math.tact

anton-trunov · 2024-11-19T13:45:34Z

src/generator/writers/writeStdlib.ts

+        ctx.asm("", "UBITSIZE");
+    });
+
+    ctx.fun(`__tact_sqrt`, () => {


how about we implement this in Tact?

and what about other stdlib functions?

if a function can be implemented efficiently in Tact, we should implement it in Tact or open an issue and fix it

src/generator/writers/writeStdlib.ts

CHANGELOG.md

Gusarich · 2024-11-28T05:23:04Z

@anton-trunov @novusnota covered all new functions with tests!

Found and fixed a few little mistakes in types (for addressNone and computeDataSize functions). Also added comments with formulas for new math functions

anton-trunov · 2024-11-28T08:52:36Z

@Gusarich Let's

resolve the merge conflicts
move the notes from "current state" to their own separate issues

anton-trunov

We should document the new functions in https://docs.tact-lang.org/ref/core-math and other relevant doc pages

novusnota · 2024-11-28T09:26:23Z

We should document the new functions in https://docs.tact-lang.org/ref/core-math and other relevant doc pages

Will do

Co-authored-by: Novus Nota <68142933+novusnota@users.noreply.github.com>

novusnota · 2024-12-01T16:40:23Z

We should document the new functions in https://docs.tact-lang.org/ref/core-math and other relevant doc pages

Halfway there, will be finishing this soon.

UPD: 2/3rds are done, got to complete the cell related functions
UPD: done!

… documented, except for `addressNone`

Gusarich · 2024-12-05T12:01:14Z

move the notes from "current state" to their own separate issues

@anton-trunov have a look at the updated notes. there are few of them that I don't think we need to cover in Tact

anton-trunov · 2024-12-05T12:04:40Z

Looks good! Thanks for adding those

…d there

novusnota · 2024-12-05T18:23:33Z

@anton-trunov @Gusarich

Added documentation for all of the new functions from this PR, except for the addressNone(), since its implementation is still in the works. Didn't add doc comments yet — once we agree on the descriptions in the documentation, then I'll quickly add the doc comments mirroring them.

docs/src/content/docs/ref/core-math.mdx

anton-trunov · 2024-12-15T12:39:48Z

src/test/e2e-emulated/contracts/math.tact

do we want to also add muldiv?

anton-trunov · 2025-01-26T06:29:03Z

Let's bring this up to date, resolve the review comments and merge

verytactical · 2025-01-27T18:25:56Z

Maybe we should split it into smaller PRs? Given the amount of discussion it created, it would probably be faster to merged if we didn't block merging the code with discussions on an unrelated part of stdlib.

An uneducated guess would be 3-4 PRs:

novusnota · 2025-01-27T19:27:30Z

Maybe we should split it into smaller PRs? Given the amount of discussion it created, it would probably be faster to merged if we didn't block merging the code with discussions on an unrelated part of stdlib.

Well, the only unresolved thing here besides merge conflics is the addressNone() function — other functions were reviewed and even have public docs written for them right in this PR already.

Therefore, I suggest @Gusarich you (or I) fix merge conflics, add the doc comments to stdlib based on the documentation I've added prior, and then the addressNone() will wait for completion as per #1029

@verytactical @anton-trunov

Gusarich · 2025-01-29T12:38:35Z

@novusnota @anton-trunov @Shvandre have a look please!

Shvandre · 2025-01-29T12:54:15Z

docs/src/content/docs/ref/core-cells.mdx

+<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+
+```tact
+extends fun depth(self: Cell): Int;


Maybe the argument should be optional? extends fun depth(self: Cell?). I haven't tested, but TVM.pdf (and TVM spec also) states

D765 — CDEPTH (c – x), returns the depth of Cell c. If c has no
references, then x = 0; otherwise x is one plus the maximum of depths
of cells referred to from c. If c is a Null instead of a Cell, returns zero.

Good point, but calling null.depth() in order to simply obtain 0 doesn't make much sense. And if the user has something like let x: Cell? = ... at any point, I doubt calling x.depth() will be an efficient way to determine if x is null or not, since the !! would still be needed for later uses that require Cell and not Cell? type.

But I might be totally wrong :)

I'd say it makes sense if your Cell? is fro, incoming message, and your logic is somehow based on that. I haven't seen those examples, but I would add that as there is no overhead, and internal TVM instruction provides support for it.

docs/src/content/docs/ref/core-cells.mdx

Shvandre · 2025-01-29T17:49:50Z

docs/src/content/docs/ref/core-cells.mdx

+<Badge text="Available since Tact 1.6" variant="tip" size="medium"/><p/>
+
+```tact
+extends fun computeDataSize(self: Cell, maxCells: Int): DataSize;


Same comment here. What are the benefits of narrowing the application of a function? CDATAZISE works fine with null, and returns $x=y=z=0$

docs/src/content/docs/ref/core-cells.mdx

docs/src/content/docs/ref/core-common.mdx

novusnota · 2025-01-30T15:20:32Z

@Gusarich is addressNone() done? That is, may I document it in its current state, returning Address??

If not, we can remove it from the changelog, docs and sources for now. And then make a follow-up PR that'll re-introduce addressNone() with changes to the Address type itself, as suggested earlier :)

Gusarich added this to the v1.6.0 milestone Oct 25, 2024

novusnota reviewed Oct 25, 2024

View reviewed changes

Gusarich force-pushed the stdlib-extension-with-mathlib branch from 178e712 to b9b6206 Compare November 17, 2024 07:41

Gusarich mentioned this pull request Nov 18, 2024

Add myCode and addressNone to stdlib #1029

Open

anton-trunov reviewed Nov 18, 2024

View reviewed changes

novusnota reviewed Nov 18, 2024

View reviewed changes

stdlib/std/math.tact Outdated Show resolved Hide resolved

anton-trunov reviewed Nov 19, 2024

View reviewed changes

src/generator/writers/writeStdlib.ts Outdated Show resolved Hide resolved

novusnota reviewed Nov 21, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Gusarich marked this pull request as ready for review November 28, 2024 05:21

Gusarich requested a review from a team as a code owner November 28, 2024 05:21

Gusarich requested review from anton-trunov and novusnota November 28, 2024 05:21

anton-trunov requested a review from Shvandre November 28, 2024 08:40

anton-trunov self-assigned this Nov 28, 2024

anton-trunov requested changes Nov 28, 2024

View reviewed changes

Gusarich and others added 10 commits November 29, 2024 15:48

feat: add missing functions from stdlib.fc

19a5f30

feat: add sgn math function

a198af0

chore: update changelog

165a125

feat: apply suggestions from code review

7941532

Co-authored-by: Novus Nota <68142933+novusnota@users.noreply.github.com>

chore: fix varuint comment in stdlib

00790e4

feat: remove stringHash due to existence of .hash method

293c7cc

feat: update stdlib.ts

fba75c7

feat: add MULRSHIFT functions

f384afc

feat: update stdlib.ts

0e3d6b4

feat: add sqrt function

1db9371

novusnota added 2 commits December 4, 2024 18:29

chore: typos and extra linkage

a2da1a2

feat(docs): all math functions and all new non-cell related functions…

2b72e66

… documented, except for `addressNone`

novusnota dismissed Shvandre’s stale review via 2b72e66 December 5, 2024 07:08

This was referenced Dec 5, 2024

Tensor types #1116

Open

VarUInt32, VarInt16, VarInt32 serialization types #1117

Closed

Fixed-point arithmetics library #1118

Open

feat(docs): new cell-related functions plus minor corrections here an…

8453507

…d there

Shvandre reviewed Dec 5, 2024

View reviewed changes

docs/src/content/docs/ref/core-math.mdx Outdated Show resolved Hide resolved

chore: typo

aa58a35

Shvandre reviewed Dec 5, 2024

View reviewed changes

docs/src/content/docs/ref/core-math.mdx Outdated Show resolved Hide resolved

chore: typo

4e73eb4

Gusarich mentioned this pull request Dec 6, 2024

Address? #1119

Open

anton-trunov reviewed Dec 15, 2024

View reviewed changes

src/test/e2e-emulated/contracts/math.tact Outdated

Copy link

Member

anton-trunov Dec 15, 2024

Choose a reason for hiding this comment

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

do we want to also add muldiv?

Gusarich added 2 commits January 29, 2025 15:34

Merge branch 'main' into stdlib-extension-with-mathlib

2f9e448

feat(cspell): add MULDIVC

aec2cc2

Shvandre reviewed Jan 29, 2025

View reviewed changes

docs/src/content/docs/ref/core-cells.mdx Show resolved Hide resolved

Shvandre reviewed Jan 29, 2025

View reviewed changes

docs/src/content/docs/ref/core-cells.mdx Show resolved Hide resolved

Shvandre reviewed Jan 29, 2025

View reviewed changes

docs/src/content/docs/ref/core-common.mdx Show resolved Hide resolved

Shvandre reviewed Jan 29, 2025

View reviewed changes

docs/src/content/docs/ref/core-common.mdx Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: new functions in stdlib from `stdlib.fc` and `math.fc` #986

feat: new functions in stdlib from `stdlib.fc` and `math.fc` #986

Gusarich commented Oct 25, 2024 •

edited by novusnota

Loading

novusnota left a comment

Gusarich commented Nov 18, 2024

anton-trunov left a comment

anton-trunov Nov 18, 2024

Gusarich Nov 18, 2024

anton-trunov Nov 18, 2024

Gusarich Nov 18, 2024

anton-trunov Nov 18, 2024

anton-trunov Nov 19, 2024

Gusarich Nov 19, 2024

anton-trunov Nov 19, 2024

Gusarich Nov 21, 2024

Gusarich commented Nov 28, 2024

anton-trunov commented Nov 28, 2024

anton-trunov left a comment •

edited

Loading

novusnota commented Nov 28, 2024

novusnota commented Dec 1, 2024 •

edited

Loading

Gusarich commented Dec 5, 2024

anton-trunov commented Dec 5, 2024

novusnota commented Dec 5, 2024

anton-trunov Dec 15, 2024

anton-trunov commented Jan 26, 2025

verytactical commented Jan 27, 2025

novusnota commented Jan 27, 2025

Gusarich commented Jan 29, 2025

Shvandre Jan 29, 2025 •

edited

Loading

novusnota Jan 29, 2025

Shvandre Jan 29, 2025

Shvandre Jan 29, 2025

novusnota commented Jan 30, 2025 •

edited

Loading

feat: new functions in stdlib from stdlib.fc and math.fc #986

Are you sure you want to change the base?

feat: new functions in stdlib from stdlib.fc and math.fc #986

Conversation

Gusarich commented Oct 25, 2024 • edited by novusnota Loading

Issue

Checklist

Current State

novusnota left a comment

Choose a reason for hiding this comment

Gusarich commented Nov 18, 2024

anton-trunov left a 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

Gusarich commented Nov 28, 2024

anton-trunov commented Nov 28, 2024

anton-trunov left a comment • edited Loading

Choose a reason for hiding this comment

novusnota commented Nov 28, 2024

novusnota commented Dec 1, 2024 • edited Loading

Gusarich commented Dec 5, 2024

anton-trunov commented Dec 5, 2024

novusnota commented Dec 5, 2024

Choose a reason for hiding this comment

anton-trunov commented Jan 26, 2025

verytactical commented Jan 27, 2025

novusnota commented Jan 27, 2025

Gusarich commented Jan 29, 2025

Shvandre Jan 29, 2025 • 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

novusnota commented Jan 30, 2025 • edited Loading

feat: new functions in stdlib from `stdlib.fc` and `math.fc` #986

feat: new functions in stdlib from `stdlib.fc` and `math.fc` #986

Gusarich commented Oct 25, 2024 •

edited by novusnota

Loading

anton-trunov left a comment •

edited

Loading

novusnota commented Dec 1, 2024 •

edited

Loading

Shvandre Jan 29, 2025 •

edited

Loading

novusnota commented Jan 30, 2025 •

edited

Loading