effect 4.0.4 → 4.0.6

package/src/MutableHashMap.ts

@@ -334,73 +334,7 @@ export const get: {
    */
   <K, V>(self: MutableHashMap<K, V>, key: K): Option.Option<V>
 } = dual<
-  /**
-   * Looks up a key in the `MutableHashMap` safely.
-   *
-   * **When to use**
-   *
-   * Use to safely read a `MutableHashMap` value for a key as an `Option`.
-   *
-   * **Details**
-   *
-   * Returns `Some(value)` when an equal key is present and `None` when the key is
-   * absent.
-   *
-   * **Example** (Getting a value)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap, Option } from "effect"
-   *
-   * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
-   *
-   * MutableHashMap.get(map, "key1") // => Option.some(42)
-   * MutableHashMap.get(map, "key3") // => Option.none()
-   *
-   * // Pipe-able version
-   * MutableHashMap.get("key1")(map) // => Option.some(42)
-   * ```
-   *
-   * @see {@link has} for checking only whether a key is present
-   * @see {@link set} for inserting or replacing a value by key
-   *
-   * @stability stable
-   * @category getters
-   * @since 2.0.0
-   */
   <K>(key: K) => <V>(self: MutableHashMap<K, V>) => Option.Option<V>,
-  /**
-   * Looks up a key in the `MutableHashMap` safely.
-   *
-   * **When to use**
-   *
-   * Use to safely read a `MutableHashMap` value for a key as an `Option`.
-   *
-   * **Details**
-   *
-   * Returns `Some(value)` when an equal key is present and `None` when the key is
-   * absent.
-   *
-   * **Example** (Getting a value)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap, Option } from "effect"
-   *
-   * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
-   *
-   * MutableHashMap.get(map, "key1") // => Option.some(42)
-   * MutableHashMap.get(map, "key3") // => Option.none()
-   *
-   * // Pipe-able version
-   * MutableHashMap.get("key1")(map) // => Option.some(42)
-   * ```
-   *
-   * @see {@link has} for checking only whether a key is present
-   * @see {@link set} for inserting or replacing a value by key
-   *
-   * @stability stable
-   * @category getters
-   * @since 2.0.0
-   */
   <K, V>(self: MutableHashMap<K, V>, key: K) => Option.Option<V>
 >(2, <K, V>(self: MutableHashMap<K, V>, key: K): Option.Option<V> => {
   if (self.backing.has(key)) {
@@ -585,63 +519,7 @@ export const has: {
    */
   <K, V>(self: MutableHashMap<K, V>, key: K): boolean
 } = dual<
-  /**
-   * Checks whether the MutableHashMap contains the specified key.
-   *
-   * **When to use**
-   *
-   * Use to test whether a key is present in a `MutableHashMap` without reading
-   * its value.
-   *
-   * **Example** (Checking for a key)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap } from "effect"
-   *
-   * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
-   *
-   * MutableHashMap.has(map, "key1") // => true
-   * MutableHashMap.has(map, "key3") // => false
-   *
-   * // Pipe-able version
-   * MutableHashMap.has("key1")(map) // => true
-   * ```
-   *
-   * @see {@link get} for reading the value as an `Option`
-   *
-   * @stability stable
-   * @category predicates
-   * @since 2.0.0
-   */
   <K>(key: K) => <V>(self: MutableHashMap<K, V>) => boolean,
-  /**
-   * Checks whether the MutableHashMap contains the specified key.
-   *
-   * **When to use**
-   *
-   * Use to test whether a key is present in a `MutableHashMap` without reading
-   * its value.
-   *
-   * **Example** (Checking for a key)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap } from "effect"
-   *
-   * const map = MutableHashMap.make(["key1", 42], ["key2", 100])
-   *
-   * MutableHashMap.has(map, "key1") // => true
-   * MutableHashMap.has(map, "key3") // => false
-   *
-   * // Pipe-able version
-   * MutableHashMap.has("key1")(map) // => true
-   * ```
-   *
-   * @see {@link get} for reading the value as an `Option`
-   *
-   * @stability stable
-   * @category predicates
-   * @since 2.0.0
-   */
   <K, V>(self: MutableHashMap<K, V>, key: K) => boolean
 >(2, (self, key) => Option.isSome(get(self, key)))
 
@@ -769,87 +647,7 @@ export const set: {
    */
   <K, V>(self: MutableHashMap<K, V>, key: K, value: V): MutableHashMap<K, V>
 } = dual<
-  /**
-   * Sets a key-value pair in the MutableHashMap, mutating the map in place.
-   * If the key already exists, its value is updated.
-   *
-   * **When to use**
-   *
-   * Use to insert a new `MutableHashMap` entry or replace an existing entry in
-   * place.
-   *
-   * **Example** (Setting key-value pairs)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap, Option } from "effect"
-   *
-   * const map = MutableHashMap.empty<string, number>()
-   *
-   * // Add new entries
-   * MutableHashMap.set(map, "key1", 42)
-   * MutableHashMap.set(map, "key2", 100)
-   *
-   * MutableHashMap.get(map, "key1") // => Option.some(42)
-   * MutableHashMap.size(map) // => 2
-   *
-   * // Update existing entry
-   * MutableHashMap.set(map, "key1", 999)
-   * MutableHashMap.get(map, "key1") // => Option.some(999)
-   *
-   * // Pipe-able version
-   * MutableHashMap.set("key3", 300)(map)
-   * MutableHashMap.size(map) // => 3
-   * ```
-   *
-   * @see {@link modify} for updating an existing value with a function
-   * @see {@link modifyAt} for setting or removing based on the current optional value
-   * @see {@link remove} for deleting an entry by key
-   *
-   * @stability stable
-   * @category mutations
-   * @since 2.0.0
-   */
   <K, V>(key: K, value: V) => (self: MutableHashMap<K, V>) => MutableHashMap<K, V>,
-  /**
-   * Sets a key-value pair in the MutableHashMap, mutating the map in place.
-   * If the key already exists, its value is updated.
-   *
-   * **When to use**
-   *
-   * Use to insert a new `MutableHashMap` entry or replace an existing entry in
-   * place.
-   *
-   * **Example** (Setting key-value pairs)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap, Option } from "effect"
-   *
-   * const map = MutableHashMap.empty<string, number>()
-   *
-   * // Add new entries
-   * MutableHashMap.set(map, "key1", 42)
-   * MutableHashMap.set(map, "key2", 100)
-   *
-   * MutableHashMap.get(map, "key1") // => Option.some(42)
-   * MutableHashMap.size(map) // => 2
-   *
-   * // Update existing entry
-   * MutableHashMap.set(map, "key1", 999)
-   * MutableHashMap.get(map, "key1") // => Option.some(999)
-   *
-   * // Pipe-able version
-   * MutableHashMap.set("key3", 300)(map)
-   * MutableHashMap.size(map) // => 3
-   * ```
-   *
-   * @see {@link modify} for updating an existing value with a function
-   * @see {@link modifyAt} for setting or removing based on the current optional value
-   * @see {@link remove} for deleting an entry by key
-   *
-   * @stability stable
-   * @category mutations
-   * @since 2.0.0
-   */
   <K, V>(self: MutableHashMap<K, V>, key: K, value: V) => MutableHashMap<K, V>
 >(3, <K, V>(self: MutableHashMap<K, V>, key: K, value: V) => {
   if (self.backing.has(key) || isSimpleKey(key)) {
@@ -1008,87 +806,7 @@ export const modify: {
    */
   <K, V>(self: MutableHashMap<K, V>, key: K, f: (v: V) => V): MutableHashMap<K, V>
 } = dual<
-  /**
-   * Updates the value of the specified key within the MutableHashMap if it exists.
-   * If the key doesn't exist, the map remains unchanged.
-   *
-   * **When to use**
-   *
-   * Use to transform an existing `MutableHashMap` value in place without
-   * inserting missing keys.
-   *
-   * **Example** (Modifying existing values)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap, Option } from "effect"
-   *
-   * const map = MutableHashMap.make(["count", 5], ["total", 100])
-   *
-   * // Increment existing value
-   * MutableHashMap.modify(map, "count", (n) => n + 1)
-   * MutableHashMap.get(map, "count") // => Option.some(6)
-   *
-   * // Double existing value
-   * MutableHashMap.modify(map, "total", (n) => n * 2)
-   * MutableHashMap.get(map, "total") // => Option.some(200)
-   *
-   * // Try to modify non-existent key (no effect)
-   * MutableHashMap.modify(map, "missing", (n) => n + 1)
-   * MutableHashMap.has(map, "missing") // => false
-   *
-   * // Pipe-able version
-   * MutableHashMap.modify("count", (n: number) => n + 1)(map)
-   * MutableHashMap.get(map, "count") // => Option.some(7)
-   * ```
-   *
-   * @see {@link set} for inserting or replacing a value directly
-   * @see {@link modifyAt} for handling both missing and existing keys
-   *
-   * @stability stable
-   * @category mutations
-   * @since 2.0.0
-   */
   <K, V>(key: K, f: (v: V) => V) => (self: MutableHashMap<K, V>) => MutableHashMap<K, V>,
-  /**
-   * Updates the value of the specified key within the MutableHashMap if it exists.
-   * If the key doesn't exist, the map remains unchanged.
-   *
-   * **When to use**
-   *
-   * Use to transform an existing `MutableHashMap` value in place without
-   * inserting missing keys.
-   *
-   * **Example** (Modifying existing values)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap, Option } from "effect"
-   *
-   * const map = MutableHashMap.make(["count", 5], ["total", 100])
-   *
-   * // Increment existing value
-   * MutableHashMap.modify(map, "count", (n) => n + 1)
-   * MutableHashMap.get(map, "count") // => Option.some(6)
-   *
-   * // Double existing value
-   * MutableHashMap.modify(map, "total", (n) => n * 2)
-   * MutableHashMap.get(map, "total") // => Option.some(200)
-   *
-   * // Try to modify non-existent key (no effect)
-   * MutableHashMap.modify(map, "missing", (n) => n + 1)
-   * MutableHashMap.has(map, "missing") // => false
-   *
-   * // Pipe-able version
-   * MutableHashMap.modify("count", (n: number) => n + 1)(map)
-   * MutableHashMap.get(map, "count") // => Option.some(7)
-   * ```
-   *
-   * @see {@link set} for inserting or replacing a value directly
-   * @see {@link modifyAt} for handling both missing and existing keys
-   *
-   * @stability stable
-   * @category mutations
-   * @since 2.0.0
-   */
   <K, V>(self: MutableHashMap<K, V>, key: K, f: (v: V) => V) => MutableHashMap<K, V>
 >(3, <K, V>(self: MutableHashMap<K, V>, key: K, f: (v: V) => V) => {
   const hasKey = self.backing.has(key)
@@ -1279,113 +997,10 @@ export const modifyAt: {
     f: (value: Option.Option<V>) => Option.Option<V>
   ): MutableHashMap<K, V>
 } = dual<
-  /**
-   * Updates or removes the specified key using a function from the current
-   * optional value to the next optional value.
-   *
-   * **When to use**
-   *
-   * Use to decide whether to insert, update, or remove a key based on its current
-   * optional value.
-   *
-   * **Example** (Updating or removing a key)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap, Option } from "effect"
-   *
-   * const map = MutableHashMap.make(["count", 5])
-   *
-   * // Update existing key
-   * MutableHashMap.modifyAt(
-   *   map,
-   *   "count",
-   *   (option) => Option.map(option, (n) => n * 2)
-   * )
-   * MutableHashMap.get(map, "count") // => Option.some(10)
-   *
-   * // Add new key
-   * MutableHashMap.modifyAt(
-   *   map,
-   *   "new",
-   *   (option) => Option.isNone(option) ? Option.some(42) : option
-   * )
-   * MutableHashMap.get(map, "new") // => Option.some(42)
-   *
-   * // Remove key by returning None
-   * MutableHashMap.modifyAt(map, "count", () => Option.none())
-   * MutableHashMap.get(map, "count") // => Option.none()
-   *
-   * // Conditional update
-   * MutableHashMap.modifyAt(
-   *   map,
-   *   "new",
-   *   (option) => Option.filter(option, (n) => n > 50) // Remove if <= 50
-   * )
-   * MutableHashMap.get(map, "new") // => Option.none()
-   * ```
-   *
-   * @see {@link modify} for updating only when the key already exists
-   * @see {@link set} for inserting or replacing directly
-   * @see {@link remove} for deleting directly
-   *
-   * @stability stable
-   * @category mutations
-   * @since 2.0.0
-   */
-  <K, V>(key: K, f: (value: Option.Option<V>) => Option.Option<V>) => (self: MutableHashMap<K, V>) => MutableHashMap<K, V>,
-  /**
-   * Updates or removes the specified key using a function from the current
-   * optional value to the next optional value.
-   *
-   * **When to use**
-   *
-   * Use to decide whether to insert, update, or remove a key based on its current
-   * optional value.
-   *
-   * **Example** (Updating or removing a key)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap, Option } from "effect"
-   *
-   * const map = MutableHashMap.make(["count", 5])
-   *
-   * // Update existing key
-   * MutableHashMap.modifyAt(
-   *   map,
-   *   "count",
-   *   (option) => Option.map(option, (n) => n * 2)
-   * )
-   * MutableHashMap.get(map, "count") // => Option.some(10)
-   *
-   * // Add new key
-   * MutableHashMap.modifyAt(
-   *   map,
-   *   "new",
-   *   (option) => Option.isNone(option) ? Option.some(42) : option
-   * )
-   * MutableHashMap.get(map, "new") // => Option.some(42)
-   *
-   * // Remove key by returning None
-   * MutableHashMap.modifyAt(map, "count", () => Option.none())
-   * MutableHashMap.get(map, "count") // => Option.none()
-   *
-   * // Conditional update
-   * MutableHashMap.modifyAt(
-   *   map,
-   *   "new",
-   *   (option) => Option.filter(option, (n) => n > 50) // Remove if <= 50
-   * )
-   * MutableHashMap.get(map, "new") // => Option.none()
-   * ```
-   *
-   * @see {@link modify} for updating only when the key already exists
-   * @see {@link set} for inserting or replacing directly
-   * @see {@link remove} for deleting directly
-   *
-   * @stability stable
-   * @category mutations
-   * @since 2.0.0
-   */
+  <K, V>(
+    key: K,
+    f: (value: Option.Option<V>) => Option.Option<V>
+  ) => (self: MutableHashMap<K, V>) => MutableHashMap<K, V>,
   <K, V>(
     self: MutableHashMap<K, V>,
     key: K,
@@ -1534,91 +1149,7 @@ export const remove: {
    */
   <K, V>(self: MutableHashMap<K, V>, key: K): MutableHashMap<K, V>
 } = dual<
-  /**
-   * Removes the specified key from the MutableHashMap, mutating the map in place.
-   * If the key doesn't exist, the map remains unchanged.
-   *
-   * **When to use**
-   *
-   * Use to delete one key from a mutable hash map in place.
-   *
-   * **Example** (Removing a key)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap } from "effect"
-   *
-   * const map = MutableHashMap.make(
-   *   ["key1", 42],
-   *   ["key2", 100],
-   *   ["key3", 200]
-   * )
-   *
-   * MutableHashMap.size(map) // => 3
-   *
-   * // Remove existing key
-   * MutableHashMap.remove(map, "key2")
-   * MutableHashMap.size(map) // => 2
-   * MutableHashMap.has(map, "key2") // => false
-   *
-   * // Remove non-existent key (no effect)
-   * MutableHashMap.remove(map, "nonexistent")
-   * MutableHashMap.size(map) // => 2
-   *
-   * // Pipe-able version
-   * MutableHashMap.remove("key1")(map)
-   * MutableHashMap.size(map) // => 1
-   * ```
-   *
-   * @see {@link clear} for removing all entries
-   * @see {@link modifyAt} for conditionally removing based on the current value
-   *
-   * @stability stable
-   * @category mutations
-   * @since 2.0.0
-   */
   <K>(key: K) => <V>(self: MutableHashMap<K, V>) => MutableHashMap<K, V>,
-  /**
-   * Removes the specified key from the MutableHashMap, mutating the map in place.
-   * If the key doesn't exist, the map remains unchanged.
-   *
-   * **When to use**
-   *
-   * Use to delete one key from a mutable hash map in place.
-   *
-   * **Example** (Removing a key)
-   *
-   * ```ts import.meta.vitest
-   * import { MutableHashMap } from "effect"
-   *
-   * const map = MutableHashMap.make(
-   *   ["key1", 42],
-   *   ["key2", 100],
-   *   ["key3", 200]
-   * )
-   *
-   * MutableHashMap.size(map) // => 3
-   *
-   * // Remove existing key
-   * MutableHashMap.remove(map, "key2")
-   * MutableHashMap.size(map) // => 2
-   * MutableHashMap.has(map, "key2") // => false
-   *
-   * // Remove non-existent key (no effect)
-   * MutableHashMap.remove(map, "nonexistent")
-   * MutableHashMap.size(map) // => 2
-   *
-   * // Pipe-able version
-   * MutableHashMap.remove("key1")(map)
-   * MutableHashMap.size(map) // => 1
-   * ```
-   *
-   * @see {@link clear} for removing all entries
-   * @see {@link modifyAt} for conditionally removing based on the current value
-   *
-   * @stability stable
-   * @category mutations
-   * @since 2.0.0
-   */
   <K, V>(self: MutableHashMap<K, V>, key: K) => MutableHashMap<K, V>
 >(2, <K, V>(self: MutableHashMap<K, V>, key_: K) => {
   if (isSimpleKey(key_)) {

package/src/Number.ts

@@ -1366,8 +1366,8 @@ function toScientificInteger(n: number): readonly [coefficient: bigint, exponent
  * @since 2.0.0
  */
 export const nextPow2 = (n: number): number => {
-  const nextPow = Math.ceil(Math.log(n) / Math.log(2))
-  return Math.max(Math.pow(2, nextPow), 2)
+  const nextPow = Math.pow(2, Math.ceil(Math.log2(n)))
+  return Math.max(nextPow < n ? nextPow * 2 : nextPow, 2)
 }
 
 /**