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.

Sign up for GitHub

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

chore(stdlib): Add examples to Int8 module #1958

Merged
merged 2 commits into from
Jan 25, 2024
Merged

chore(stdlib): Add examples to Int8 module #1958

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9901151
chore(stdlib): Add examples to `Int8` docs
spotandjake Jan 3, 2024
62a42eb
chore: Apply suggestions from code review
spotandjake Jan 24, 2024
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
85 changes: 85 additions & 0 deletions stdlib/int8.gr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
* Utilities for working with the Int8 type.
* @example include "int8"
*
* @example 1s
* @example -1s
*
* @since v0.6.0
*/

Expand Down Expand Up @@ -51,6 +54,8 @@ provide { fromNumber, toNumber }
* @param number: The value to convert
* @returns The Uint8 represented as an Int8
*
* @example Int8.fromUint8(1us) == 1s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -67,6 +72,9 @@ provide let fromUint8 = (x: Uint8) => {
* @param value: The value to increment
* @returns The incremented value
*
* @example Int8.incr(1s) == 2s
* @example Int8.incr(-2s) == -1s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -83,6 +91,9 @@ provide let incr = (value: Int8) => {
* @param value: The value to decrement
* @returns The decremented value
*
* @example Int8.decr(2s) == 1s
* @example Int8.decr(0s) == -1s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -100,6 +111,10 @@ provide let decr = (value: Int8) => {
* @param y: The second operand
* @returns The sum of the two operands
*
* @example
* from Int use { (+) }
Copy link
Member

Choose a reason for hiding this comment

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

Int8

* assert 1s + 1s == 2s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -121,6 +136,10 @@ provide let (+) = (x: Int8, y: Int8) => {
* @param y: The second operand
* @returns The difference of the two operands
*
* @example
* from Int8 use { (-) }
* assert 2s - 1s == 1s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -139,6 +158,10 @@ provide let (-) = (x: Int8, y: Int8) => {
* @param y: The second operand
* @returns The product of the two operands
*
* @example
* from Int8 use { (*) }
* assert 2s * 2s == 4s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -156,6 +179,10 @@ provide let (*) = (x: Int8, y: Int8) => {
* @param y: The second operand
* @returns The quotient of its operands
*
* @example
* from Int8 use { (/) }
* assert 8s / 2s == 4s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -174,6 +201,8 @@ provide let (/) = (x: Int8, y: Int8) => {
* @param y: The second operand
* @returns The remainder of its operands
*
* @example Int8.rem(8s, 3s) == 2s
*
* @since v0.6.0
*/
@unsafe
Expand Down Expand Up @@ -202,6 +231,10 @@ let abs = n => {
*
* @throws ModuloByZero: When `y` is zero
*
* @example
* from Int8 use { (%) }
* assert -5s % 3s == 1s
*
* @since v0.6.0
*/
@unsafe
Expand Down Expand Up @@ -233,6 +266,10 @@ provide let (%) = (x: Int8, y: Int8) => {
* @param amount: The number of bits to shift by
* @returns The shifted value
*
* @example
* from Int8 use { (<<) }
* assert (5s << 1s) == 10s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -252,6 +289,10 @@ provide let (<<) = (value: Int8, amount: Int8) => {
* @param amount: The amount to shift by
* @returns The shifted value
*
* @example
* from Int8 use { (>>) }
* assert (5s >> 1s) == 2s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -271,6 +312,10 @@ provide let (>>) = (value: Int8, amount: Int8) => {
* @param y: The second value
* @returns `true` if the first value is equal to the second value or `false` otherwise
*
* @example
* from Int8 use { (==) }
* assert 1s == 1s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -287,6 +332,10 @@ provide let (==) = (x: Int8, y: Int8) => {
* @param y: The second value
* @returns `true` if the first value is not equal to the second value or `false` otherwise
*
* @example
* from Int8 use { (!=) }
* assert 1s != 2s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -303,6 +352,10 @@ provide let (!=) = (x: Int8, y: Int8) => {
* @param y: The second value
* @returns `true` if the first value is less than the second value or `false` otherwise
*
* @example
* from Int8 use { (<) }
* assert 1s < 2s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -319,6 +372,10 @@ provide let (<) = (x: Int8, y: Int8) => {
* @param y: The second value
* @returns `true` if the first value is greater than the second value or `false` otherwise
*
* @example
* from Int8 use { (>) }
* assert 2s > 1s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -335,6 +392,13 @@ provide let (>) = (x: Int8, y: Int8) => {
* @param y: The second value
* @returns `true` if the first value is less than or equal to the second value or `false` otherwise
*
* @example
* from Int8 use { (<=) }
* assert 1s <= 2s
* @example
* from Int8 use { (<=) }
* assert 1s <= 1s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -351,6 +415,13 @@ provide let (<=) = (x: Int8, y: Int8) => {
* @param y: The second value
* @returns `true` if the first value is greater than or equal to the second value or `false` otherwise
*
* @example
* from Int8 use { (>=) }
* assert 2s >= 1s
* @example
* from Int8 use { (>=) }
* assert 1s >= 1s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -366,6 +437,8 @@ provide let (>=) = (x: Int8, y: Int8) => {
* @param value: The given value
* @returns Containing the inverted bits of the given value
*
* @example Int.lnot(-5s) == 4s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -381,6 +454,10 @@ provide let lnot = (value: Int8) => {
* @param y: The second operand
* @returns Containing a `1` in each bit position for which the corresponding bits of both operands are `1`
*
* @example
* from Int8 use { (&) }
* assert (3s & 4s) == 0s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -399,6 +476,10 @@ provide let (&) = (x: Int8, y: Int8) => {
* @param y: The second operand
* @returns Containing a `1` in each bit position for which the corresponding bits of either or both operands are `1`
*
* @example
* from Int8 use { (|) }
* assert (3s | 4s) == 7s
*
* @since v0.6.0
*/
@unsafe
Expand All @@ -417,6 +498,10 @@ provide let (|) = (x: Int8, y: Int8) => {
* @param y: The second operand
* @returns Containing a `1` in each bit position for which the corresponding bits of either but not both operands are `1`
*
* @example
* from Int8 use { (^) }
* assert (3s ^ 5s) == 6s
*
* @since v0.6.0
*/
@unsafe
Expand Down
Loading
Loading