Money/com.eriksencosta.money.allocation

Package-level declarations

Allocation features for Money.

Types

sealed interface Allocation<T : AllocationBy>

Defines the Money allocation interface.

sealed interface AllocationBy

Defines the allocation parameter types.

sealed class Allocator<T : AllocationBy> : Allocation<T>

Base class for Allocation implementations. This class implements the Template Method pattern. Subclasses need to override the following members:

interface EvenAllocation : Allocation<EvenParts>

Allocates a Money amount in even parts.

class EvenAllocator(differenceAllocator: DifferenceAllocation) : Allocator<EvenParts> , EvenAllocation

Allocates a Money in equal parts. Example:

class EvenParts(val parts: Int) : AllocationBy

Parameter type for even allocation.

ProportionalAllocation

interface ProportionalAllocation : Allocation<Ratios>

Allocates a Money in ratios.

ProportionalAllocator

class ProportionalAllocator(differenceAllocator: DifferenceAllocation) : Allocator<Ratios> , ProportionalAllocation

Allocates a Money in ratios. Example:

class Ratios(val ratios: List<Percentage>) : AllocationBy

Parameter type for proportional allocation.

class Result

Represents the result of the allocation operation.

Functions

adjustForAllocate

fun List<Percentage>.adjustForAllocate(tolerance: Double = TOLERANCE): List<Percentage>

Adjust a list of Percentage to sum up to 100% if the difference is within the given tolerance. Useful when working with a list of Percentage calculated using floating-point arithmetic.

infix fun Money.allocate(by: AllocationBy): Result

Allocates a Money according to the by parameter:

fun Money.allocate(vararg ratios: Percentage): Result

infix fun Money.allocate(ratios: List<Percentage>): Result

Allocates a Money in ratios. Example:

infix fun Money.allocate(parts: Int): Result

Allocates a Money in equal parts. Example: