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

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

Issue

Closes #770, closes #1029

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
- no minmax and no slice_bits_refs because we don't have tensor types in Tact and it would be useless
- no set_data and get_data because Tact manages persistent storage by itself
- no bless and other continuation functions because Tact doesn't support continuations natively
- no raw_reserve_extra because it requires an uint32 -> varuint32 dictionary and we only support varuint16 for values currently
All mathlib.fc functions are present in Tact stdlib in some form, with some exceptions:
- no fixed-point arithmetic related functions
- no nan and is_nan because we don't support NaN in Tact
- 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
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

anton-trunov · 2024-11-18T07:46:32Z

CHANGELOG.md

@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The `replace` and `replaceGet` methods for the `Map` type: PR [#941](https://github.com/tact-lang/tact/pull/941)
 - Utility for logging errors in code that was supposed to be unreachable: PR [#991](https://github.com/tact-lang/tact/pull/991)
 - Docs: `preloadRef` method for the `Slice` type: PR [#1044](https://github.com/tact-lang/tact/pull/1044)
+- New functions in stdlib from `stdlib.fc` and `math.fc`: PR [#986](https://github.com/tact-lang/tact/pull/986)


Let's list all the new functions here -- this is super-useful for editor plugins

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

novusnota · 2024-11-18T10:12:23Z

stdlib/std/math.tact

+
+// floor(x*y/2^z)
+asm fun mulrshift(x: Int, y: Int, z: Int): Int { MULRSHIFT }


Suggested change

asm fun mulrshift(x: Int, y: Int, z: Int): Int { MULRSHIFT }

asm fun mulShiftRight(x: Int, y: Int, z: Int): Int { MULRSHIFT }

Not sure if that'll make it less recognizable to users that know about MULRSHIFT instruction, but it'll definitely make the function more accessible to others :)

Similar functions can be renamed in similar fashion

let two: Int = 2;
two >> 1; // 1
4 >> 1; // 2
5 >> 1; // 2, due to flooring of integer values

pow(2, 254) >> 254; // 1

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

anton-trunov · 2024-11-19T15:01:55Z

src/generator/writers/writeStdlib.ts

+                int x = (s == 1 ? (num - 1) / 2 + 1 : 1 << ((s + 1) / 2));
+
+                do {
+                    int q = (muldivc(num, 1, x) - x) / 2;


looks like muldivc(num, 1, x) can be replaced with divc

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>

… function for both cell and slice

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

Gusarich · 2024-11-29T12:53:29Z

@anton-trunov rebased

Shvandre · 2024-11-30T19:44:52Z

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

+    }
+
+    get fun addressNone(): Address? {


Why does it return "Maybe Address" and not "Address" ?

Because the way Tact currently work with addresses is that "null" as an address is actually addressNone

Well, I checked the sources and you are 100% right, but maybe we should change it?
Or change the tlb schemes generation, because

struct Test { my_addr: Address?; }

results

## Test TLB: `_ my_addr:Maybe address = Test` Signature: `Test{my_addr:Maybe address}`

In .md file (and maybe in some other places)

it's an old problem in Tact, which was blocking multiple issues in the past. I remember some old comments in address-related issues about that.

My opinion is that we should rework addresses, because currently the way they work is not intuitive and doesn't fit into how other types work.
Basically, addr_none should be a valid part of Address type and should be checked by devs against addressNone() (and not null). And Address? should mean Maybe Address, which also could contain addr_none.
@anton-trunov what do you think?

addr_none should be a valid part of Address type and should be checked by devs against addressNone() (and not null).

yeah, this is how it should work, indeed

And Address? should mean Maybe Address

also agreed

which also could contain addr_none.

this one I'm not sure about, I'd say addr_none in the optional version should be 000, what do you think?

this one I'm not sure about, I'd say addr_none in the optional version should be 000, what do you think?

well yes, that's what I meant. I was talking about the possibility of the case when value of Address? is equal to addressNone().

@Gusarich Maybe you could take care of this change first (allowing addr_none as an inhabitant of the Address type) and then we merge this PR with the corresponding changes

We could also probably add a config option to turn off address verification along the way

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

stdlib/std/cells.tact

stdlib/std/math.tact

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 Monday-Tuesday

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

Extension of stdlib #1029

Open

anton-trunov reviewed Nov 18, 2024

View reviewed changes

novusnota reviewed Nov 18, 2024

View reviewed changes

anton-trunov reviewed Nov 19, 2024

View reviewed changes

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

Gusarich and others added 12 commits November 29, 2024 15:49

feat: sliceLast -> lastBits, and make computeDataSize an extend…

a403986

… function for both cell and slice

chore: add all function names to changelog

364dbf8

feat: addressNone

30038ca

feat: rename mulrshift functions

58c33b5

feat: rewrite sqrt on tact

cbd36dc

chore: update serialization snapshots

2aca980

chore: update cspell ignorelist

3dcaf2a

chore: update CHANGELOG.md

83d69e7

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

fix: addressNone and computeDataSize types

e801103

chore: add comments with specs for new math functions

b0ec774

feat: cover new functions with tests

4d05722

feat: update stdlib.ts

734f3a0

Gusarich force-pushed the stdlib-extension-with-mathlib branch from 8a5fed9 to 734f3a0 Compare November 29, 2024 12:53

Gusarich requested a review from anton-trunov November 29, 2024 12:53

Shvandre reviewed Nov 30, 2024

View reviewed changes

src/test/e2e-emulated/contracts/stdlib.tact Show resolved Hide resolved

Shvandre reviewed Nov 30, 2024

View reviewed changes

stdlib/std/cells.tact Show resolved Hide resolved

Shvandre reviewed Nov 30, 2024

View reviewed changes

stdlib/std/math.tact Show resolved Hide resolved

Shvandre self-requested a review December 1, 2024 13:20

Shvandre approved these changes Dec 1, 2024

View reviewed changes

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

Loading

novusnota left a comment

Gusarich commented Nov 18, 2024

anton-trunov left a comment

anton-trunov Nov 18, 2024

Gusarich Nov 18, 2024

NaNOteh Nov 24, 2024

anton-trunov Nov 18, 2024

Gusarich Nov 18, 2024

anton-trunov Nov 18, 2024

Gusarich Nov 18, 2024

anton-trunov Nov 18, 2024

novusnota Nov 18, 2024

NaNOteh Nov 19, 2024

Gusarich Nov 21, 2024

anton-trunov Nov 19, 2024

Gusarich Nov 19, 2024

anton-trunov Nov 19, 2024

Gusarich Nov 21, 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

Gusarich commented Nov 29, 2024

Shvandre Nov 30, 2024

Gusarich Dec 1, 2024

Shvandre Dec 1, 2024

Gusarich Dec 2, 2024

anton-trunov Dec 2, 2024

Gusarich Dec 2, 2024 •

edited

Loading

anton-trunov Dec 2, 2024

anton-trunov Dec 2, 2024

novusnota commented Dec 1, 2024


		// floor(x*y/2^z)
		asm fun mulrshift(x: Int, y: Int, z: Int): Int { MULRSHIFT }

	asm fun mulrshift(x: Int, y: Int, z: Int): Int { MULRSHIFT }
	asm fun mulShiftRight(x: Int, y: Int, z: Int): Int { MULRSHIFT }

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 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

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

Gusarich commented Nov 29, 2024

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 Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

novusnota commented Dec 1, 2024

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

Loading

anton-trunov left a comment •

edited

Loading

Gusarich Dec 2, 2024 •

edited

Loading