@grain/stdlib 0.5.13 → 0.6.1

package/immutableset.md

@@ -1,449 +0,0 @@
----
-title: ImmutableSet
----
-
-An ImmutableSet is a collection of unique values. Operations on an ImmutableSet do not mutate the set's internal state.
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-import ImmutableSet from "immutableset"
-```
-
-## Types
-
-Type declarations included in the ImmutableSet module.
-
-### ImmutableSet.**ImmutableSet**
-
-```grain
-type ImmutableSet<a>
-```
-
-## Values
-
-Functions and constants for working with ImmutableSets.
-
-### ImmutableSet.**empty**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-empty : ImmutableSet<a>
-```
-
-An empty set
-
-### ImmutableSet.**size**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-size : ImmutableSet<a> -> Number
-```
-
-Provides the count of values within the set.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`set`|`ImmutableSet<a>`|The set to inspect|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`Number`|The count of elements in the set|
-
-### ImmutableSet.**isEmpty**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-isEmpty : ImmutableSet<a> -> Bool
-```
-
-Determines if the set contains no elements.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`set`|`ImmutableSet<a>`|The set to inspect|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`Bool`|`true` if the given set is empty or `false` otherwise|
-
-### ImmutableSet.**add**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-add : (a, ImmutableSet<a>) -> ImmutableSet<a>
-```
-
-Produces a new set by inserting the given value into the set. If the value
-already exists, the new set will have the same elements as the input set.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`key`|`a`|The value to add|
-|`set`|`ImmutableSet<a>`|The base set|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`ImmutableSet<a>`|A new set containing the new element|
-
-### ImmutableSet.**contains**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-contains : (a, ImmutableSet<a>) -> Bool
-```
-
-Determines if the set contains the given value.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`key`|`a`|The value to search for|
-|`set`|`ImmutableSet<a>`|The set to search|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`Bool`|`true` if the set contains the given value or `false` otherwise|
-
-### ImmutableSet.**remove**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-remove : (a, ImmutableSet<a>) -> ImmutableSet<a>
-```
-
-Produces a new set without the given element. If the value doesn't exist in
-the set, the set will be returned unmodified.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`key`|`a`|The value to exclude|
-|`set`|`ImmutableSet<a>`|The set to exclude from|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`ImmutableSet<a>`|A new set without the excluded element|
-
-### ImmutableSet.**forEach**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-forEach : ((a -> Void), ImmutableSet<a>) -> Void
-```
-
-Iterates the set, calling an iterator function on each element.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`fn`|`a -> Void`|The iterator function to call with each element|
-|`set`|`ImmutableSet<a>`|The set to iterate|
-
-### ImmutableSet.**reduce**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-reduce : (((a, b) -> a), a, ImmutableSet<b>) -> a
-```
-
-Combines all elements of a set using a reducer function.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`fn`|`(a, b) -> a`|The reducer function to call on each element, where the value returned will be the next accumulator value|
-|`init`|`a`|The initial value to use for the accumulator on the first iteration|
-|`set`|`ImmutableSet<b>`|The set to iterate|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`a`|The final accumulator returned from `fn`|
-
-### ImmutableSet.**filter**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-filter : ((a -> Bool), ImmutableSet<a>) -> ImmutableSet<a>
-```
-
-Produces a new set without the elements from the input set where a predicate function returns `false`.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`fn`|`a -> Bool`|The predicate function to indicate which elements to exclude from the set, where returning `false` indicates the value should be excluded|
-|`set`|`ImmutableSet<a>`|The set to iterate|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`ImmutableSet<a>`|A new set excluding the elements not fulfilling the predicate|
-
-### ImmutableSet.**reject**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-reject : ((a -> Bool), ImmutableSet<a>) -> ImmutableSet<a>
-```
-
-Produces a new set without the elements from the input set where a predicate function returns `true`.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`fn`|`a -> Bool`|The predicate function to indicate which elements to exclude from the set, where returning `true` indicates the value should be excluded|
-|`set`|`ImmutableSet<a>`|The set to iterate|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`ImmutableSet<a>`|A new set excluding the elements fulfilling the predicate|
-
-### ImmutableSet.**union**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-union : (ImmutableSet<a>, ImmutableSet<a>) -> ImmutableSet<a>
-```
-
-Combines two sets into a single set containing all elements from both sets.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`set1`|`ImmutableSet<a>`|The first set to combine|
-|`set2`|`ImmutableSet<a>`|The second set to combine|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`ImmutableSet<a>`|A set containing all elements of both sets|
-
-### ImmutableSet.**diff**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-diff : (ImmutableSet<a>, ImmutableSet<a>) -> ImmutableSet<a>
-```
-
-Combines two sets into a single set containing only the elements not shared between both sets.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`set1`|`ImmutableSet<a>`|The first set to combine|
-|`set2`|`ImmutableSet<a>`|The second set to combine|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`ImmutableSet<a>`|A set containing only unshared elements from both sets|
-
-### ImmutableSet.**intersect**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-intersect : (ImmutableSet<a>, ImmutableSet<a>) -> ImmutableSet<a>
-```
-
-Combines two sets into a single set containing only the elements shared between both sets.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`set1`|`ImmutableSet<a>`|The first set to combine|
-|`set2`|`ImmutableSet<a>`|The second set to combine|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`ImmutableSet<a>`|A set containing only shared elements from both sets|
-
-### ImmutableSet.**fromList**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-fromList : List<a> -> ImmutableSet<a>
-```
-
-Creates a set from a list.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`list`|`List<a>`|The list to convert|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`ImmutableSet<a>`|A set containing all list values|
-
-### ImmutableSet.**toList**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-toList : ImmutableSet<a> -> List<a>
-```
-
-Converts a set into a list of its elements.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`set`|`ImmutableSet<a>`|The set to convert|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`List<a>`|A list containing all set values|
-
-### ImmutableSet.**fromArray**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-fromArray : Array<a> -> ImmutableSet<a>
-```
-
-Creates a set from an array.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`array`|`Array<a>`|The array to convert|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`ImmutableSet<a>`|A set containing all array values|
-
-### ImmutableSet.**toArray**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.4</code></summary>
-No other changes yet.
-</details>
-
-```grain
-toArray : ImmutableSet<a> -> Array<a>
-```
-
-Converts a set into an array of its elements.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`set`|`ImmutableSet<a>`|The set to convert|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`Array<a>`|An array containing all set values|
-

package/runtime/debug.gr

@@ -1,2 +0,0 @@
-/* grainc-flags --compilation-mode=runtime */
-export foreign wasm debug: a -> Void from "console"

package/runtime/debug.md

@@ -1,6 +0,0 @@
-### Debug.**debug**
-
-```grain
-debug : a -> Void
-```
-

package/runtime/unsafe/errors.gr

@@ -1,36 +0,0 @@
-/* grainc-flags --compilation-mode=runtime */
-
-export let _GRAIN_ERR_NOT_NUMBER_COMP = 0n
-export let _GRAIN_ERR_NOT_NUMBER_ARITH = 1n
-export let _GRAIN_ERR_NOT_BOOLEAN_LOGIC = 2n
-export let _GRAIN_ERR_NOT_BOOLEAN_IF = 3n
-export let _GRAIN_ERR_OVERFLOW = 4n
-export let _GRAIN_ERR_GET_NOT_TUP = 5n
-export let _GRAIN_ERR_GET_ITEM_IDX_NOT_NUMBER = 6n
-export let _GRAIN_ERR_GET_ITEM_IDX_TOO_SMALL = 7n
-export let _GRAIN_ERR_GET_ITEM_IDX_TOO_LARGE = 8n
-export let _GRAIN_ERR_CALLED_NON_FUNCTION = 9n
-export let _GRAIN_ERR_ARITY_MISMATCH = 10n
-export let _GRAIN_ERR_OUT_OF_MEMORY = 11n
-export let _GRAIN_ERR_SET_NOT_TUP = 12n
-export let _GRAIN_ERR_SET_ITEM_IDX_NOT_NUMBER = 13n
-export let _GRAIN_ERR_SET_ITEM_IDX_TOO_SMALL = 14n
-export let _GRAIN_ERR_SET_ITEM_IDX_TOO_LARGE = 15n
-export let _GRAIN_ERR_DIVISION_BY_ZERO = 17n
-export let _GRAIN_ERR_MODULO_BY_ZERO = 18n
-export let _GRAIN_ERR_ARRAY_INDEX_OUT_OF_BOUNDS = 19n
-export let _GRAIN_ERR_INVALID_ARGUMENT = 20n
-export let _GRAIN_ERR_ASSERTION_ERROR = 21n
-export let _GRAIN_ERR_FAILURE = 22n
-export let _GRAIN_ERR_SYSTEM = 23n
-export let _GRAIN_ERR_NOT_INTLIKE = 24n
-export let _GRAIN_ERR_NOT_RATIONAL = 25n
-export let _GRAIN_ERR_MALFORMED_UTF8 = 26n
-export let _GRAIN_ERR_NOT_ADT_VAL_GENERIC = 91n
-export let _GRAIN_ERR_NOT_STRING_GENERIC = 93n
-export let _GRAIN_ERR_NOT_BOOLEAN_GENERIC = 94n
-export let _GRAIN_ERR_NOT_TUPLE_GENERIC = 95n
-export let _GRAIN_ERR_NOT_LAMBDA_GENERIC = 96n
-export let _GRAIN_ERR_BAD_INPUT = 97n
-export let _GRAIN_ERR_NOT_NONNEG = 98n
-export let _GRAIN_ERR_NOT_NUMBER_GENERIC = 99n

package/runtime/unsafe/errors.md

@@ -1,204 +0,0 @@
-### Errors.**_GRAIN_ERR_NOT_NUMBER_COMP**
-
-```grain
-_GRAIN_ERR_NOT_NUMBER_COMP : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_NUMBER_ARITH**
-
-```grain
-_GRAIN_ERR_NOT_NUMBER_ARITH : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_BOOLEAN_LOGIC**
-
-```grain
-_GRAIN_ERR_NOT_BOOLEAN_LOGIC : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_BOOLEAN_IF**
-
-```grain
-_GRAIN_ERR_NOT_BOOLEAN_IF : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_OVERFLOW**
-
-```grain
-_GRAIN_ERR_OVERFLOW : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_GET_NOT_TUP**
-
-```grain
-_GRAIN_ERR_GET_NOT_TUP : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_GET_ITEM_IDX_NOT_NUMBER**
-
-```grain
-_GRAIN_ERR_GET_ITEM_IDX_NOT_NUMBER : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_GET_ITEM_IDX_TOO_SMALL**
-
-```grain
-_GRAIN_ERR_GET_ITEM_IDX_TOO_SMALL : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_GET_ITEM_IDX_TOO_LARGE**
-
-```grain
-_GRAIN_ERR_GET_ITEM_IDX_TOO_LARGE : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_CALLED_NON_FUNCTION**
-
-```grain
-_GRAIN_ERR_CALLED_NON_FUNCTION : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_ARITY_MISMATCH**
-
-```grain
-_GRAIN_ERR_ARITY_MISMATCH : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_OUT_OF_MEMORY**
-
-```grain
-_GRAIN_ERR_OUT_OF_MEMORY : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_SET_NOT_TUP**
-
-```grain
-_GRAIN_ERR_SET_NOT_TUP : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_SET_ITEM_IDX_NOT_NUMBER**
-
-```grain
-_GRAIN_ERR_SET_ITEM_IDX_NOT_NUMBER : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_SET_ITEM_IDX_TOO_SMALL**
-
-```grain
-_GRAIN_ERR_SET_ITEM_IDX_TOO_SMALL : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_SET_ITEM_IDX_TOO_LARGE**
-
-```grain
-_GRAIN_ERR_SET_ITEM_IDX_TOO_LARGE : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_DIVISION_BY_ZERO**
-
-```grain
-_GRAIN_ERR_DIVISION_BY_ZERO : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_MODULO_BY_ZERO**
-
-```grain
-_GRAIN_ERR_MODULO_BY_ZERO : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_ARRAY_INDEX_OUT_OF_BOUNDS**
-
-```grain
-_GRAIN_ERR_ARRAY_INDEX_OUT_OF_BOUNDS : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_INVALID_ARGUMENT**
-
-```grain
-_GRAIN_ERR_INVALID_ARGUMENT : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_ASSERTION_ERROR**
-
-```grain
-_GRAIN_ERR_ASSERTION_ERROR : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_FAILURE**
-
-```grain
-_GRAIN_ERR_FAILURE : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_SYSTEM**
-
-```grain
-_GRAIN_ERR_SYSTEM : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_INTLIKE**
-
-```grain
-_GRAIN_ERR_NOT_INTLIKE : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_RATIONAL**
-
-```grain
-_GRAIN_ERR_NOT_RATIONAL : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_MALFORMED_UTF8**
-
-```grain
-_GRAIN_ERR_MALFORMED_UTF8 : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_ADT_VAL_GENERIC**
-
-```grain
-_GRAIN_ERR_NOT_ADT_VAL_GENERIC : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_STRING_GENERIC**
-
-```grain
-_GRAIN_ERR_NOT_STRING_GENERIC : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_BOOLEAN_GENERIC**
-
-```grain
-_GRAIN_ERR_NOT_BOOLEAN_GENERIC : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_TUPLE_GENERIC**
-
-```grain
-_GRAIN_ERR_NOT_TUPLE_GENERIC : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_LAMBDA_GENERIC**
-
-```grain
-_GRAIN_ERR_NOT_LAMBDA_GENERIC : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_BAD_INPUT**
-
-```grain
-_GRAIN_ERR_BAD_INPUT : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_NONNEG**
-
-```grain
-_GRAIN_ERR_NOT_NONNEG : WasmI32
-```
-
-### Errors.**_GRAIN_ERR_NOT_NUMBER_GENERIC**
-
-```grain
-_GRAIN_ERR_NOT_NUMBER_GENERIC : WasmI32
-```
-