Jido.Evolve.Options (Jido Evolve v1.0.0)

Copy Markdown View Source

Canonical option validation and normalization for Jido.Evolve.evolve/1.

Summary

Types

t()

Functions

new(opts)

Validate and normalize public evolve options.

new!(opts)

Validate and normalize options, raising on invalid input.

Types

t()

@type t() :: %Jido.Evolve.Options{
  config: nil | nil | any(),
  context: map(),
  crossover: nil | nil | any(),
  fitness: any(),
  initial_population: [any()],
  mutation: nil | nil | any(),
  selection: nil | nil | any()
}

Functions

new(opts)

@spec new(keyword() | map()) :: {:ok, t()} | {:error, Exception.t()}

Validate and normalize public evolve options.

new!(opts)

@spec new!(keyword() | map()) :: t()

Validate and normalize options, raising on invalid input.