Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description for Range #952

Merged
merged 4 commits into from
Jan 17, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions mathics/builtin/list/constructing.py
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,12 @@ class Range(Builtin):

<dt>'Range[$a$, $b$]'
<dd>returns a list of integers from $a$ to $b$.

<dt>'Range[$a$, $b$, $di$]'
<dd>returns a list of integers from $a$ to $b$ using step $di$.
Copy link

@axkr axkr Dec 18, 2023

Choose a reason for hiding this comment

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

Not only integers but appropriate values.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for your suggestion. Do you think the current one is better, or simply returns a list of numbers from $a$ to $b$.?

Copy link

Choose a reason for hiding this comment

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

Not only numbers if you see this example:

Together can help to simplify the expressions generated by the iterator to real values:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

However, Range in Mathics3 only accepts real arguments for now. For some historical reason it does not use the same implementation as Table, which makes it more efficient while having more limited applicability.

Anyway, your suggestion sounds good and I think it's worth considering in our future reorganization of historical codes including Range. Would you mind putting your suggestions to Issues? That way we can remember it after this PR is closed (which could be soon since I don't have time to rewrite Range in this PR for now).

Copy link

Choose a reason for hiding this comment

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

I think you can better add details in an issue, how to use the Table iterator implementation for Range.

More specifically, 'Range' starts from $a$ and successively adds \
increments of $di$ until the result is greater (if $di$ > 0) or \
less (if $di$ < 0) than $b$.
</dl>

>> Range[5]
Expand Down