/** * @since 0.24.0 */ import type { Bounded } from "./Bounded.js" import type { Semigroup } from "./Semigroup.js" import * as semigroup from "./Semigroup.js" /** * @category type class * @since 0.24.0 */ export interface Monoid extends Semigroup { readonly empty: A readonly combineAll: (collection: Iterable) => A } /** * @category constructors * @since 0.24.0 */ export const fromSemigroup = (S: Semigroup, empty: Monoid["empty"]): Monoid => ({ combine: S.combine, combineMany: S.combineMany, empty, combineAll: (collection) => S.combineMany(empty, collection) }) /** * Get a monoid where `combine` will return the minimum, based on the provided bounded order. * * The `empty` value is the `maxBound` value. * * @category constructors * @since 0.24.0 */ export const min = (B: Bounded): Monoid => fromSemigroup(semigroup.min(B.compare), B.maxBound) /** * Get a monoid where `combine` will return the maximum, based on the provided bounded order. * * The `empty` value is the `minimum` value. * * @category constructors * @since 0.24.0 */ export const max = (B: Bounded): Monoid => fromSemigroup(semigroup.max(B.compare), B.minBound) /** * The dual of a `Monoid`, obtained by swapping the arguments of `combine`. * * @category combinators * @since 0.24.0 */ export const reverse = (M: Monoid): Monoid => fromSemigroup(semigroup.reverse(M), M.empty) /** * Similar to `Promise.all` but operates on `Monoid`s. * * ``` * [Monoid, Monoid, ...] -> Monoid<[A, B, ...]> * ``` * * This function creates and returns a new `Monoid` for a tuple of values based on the given `Monoid`s for each element in the tuple. * The returned `Monoid` combines two tuples of the same type by applying the corresponding `Monoid` passed as arguments to each element in the tuple. * * The `empty` value of the returned `Monoid` is the tuple of `empty` values of the input `Monoid`s. * * It is useful when you need to combine two tuples of the same type and you have a specific way of combining each element of the tuple. * * @category combinators * @since 0.24.0 */ export const tuple = >>( ...elements: T ): Monoid<{ readonly [I in keyof T]: [T[I]] extends [Monoid] ? A : never }> => { const empty = elements.map((m) => m.empty) as any return fromSemigroup(semigroup.tuple(...elements), empty) } /** * Given a type `A`, this function creates and returns a `Semigroup` for `ReadonlyArray`. * * The `empty` value is the empty array. * * @category combinators * @since 0.24.0 */ export const array = (): Monoid> => fromSemigroup(semigroup.array(), []) /** * This function creates and returns a new `Monoid` for a struct of values based on the given `Monoid`s for each property in the struct. * The returned `Monoid` combines two structs of the same type by applying the corresponding `Monoid` passed as arguments to each property in the struct. * * The `empty` value of the returned `Monoid` is a struct where each property is the `empty` value of the corresponding `Monoid` in the input `monoids` object. * * It is useful when you need to combine two structs of the same type and you have a specific way of combining each property of the struct. * * @category combinators * @since 0.24.0 */ export const struct = }>( fields: R ): Monoid<{ readonly [K in keyof R]: [R[K]] extends [Monoid] ? A : never }> => { const empty = {} as any for (const k in fields) { if (Object.prototype.hasOwnProperty.call(fields, k)) { empty[k] = fields[k].empty } } return fromSemigroup(semigroup.struct(fields), empty) }