Ruler v0.1.0

Ruler.Engine (Ruler v0.1.0) View Source

Link to this section Summary

Types

action()
activation()
activation_event()
fact()
instruction()
log_event()
rule()
state()
t()

Functions

add_facts(engine, facts)
add_instruction(engine, instruction)
add_instructions(engine, instructions)
add_log_event(engine, log_event)
add_rules(engine, rules)
choose_from_conflict_set(engine)
commit_activation_event(engine, arg)
done?(engine)
new()
process_activation_event(engine, event)
process_instruction(engine, arg)
process_next_instruction_from_queue(engine)
query(engine, clauses)
remove_facts(engine, facts)
run_until_done(engine)
step(engine)

Link to this section Types

Link to this type

action()

View Source

Specs

action() :: Ruler.Action.t()
Link to this type

activation()

View Source

Specs

activation() :: Ruler.Activation.t()
Link to this type

activation_event()

View Source

Specs

activation_event() :: Ruler.State.activation_event()
Link to this type

fact()

View Source

Specs

fact() :: Ruler.Fact.t()
Link to this type

instruction()

View Source

Specs

instruction() ::
  {:add_fact, fact()} | {:remove_fact, fact()} | {:add_rule, rule()}
Link to this type

log_event()

View Source

Specs

log_event() ::
  {:instruction, instruction()}
  | {:add_fact_source, fact(), Ruler.State.FactInfo.source()}
  | {:remove_fact_source, fact(), Ruler.State.FactInfo.source()}
  | {:fact_was_added, fact()}
  | {:fact_was_removed, fact()}
  | {:activation_event, activation_event()}
Link to this type

rule()

View Source

Specs

rule() :: Ruler.Rule.t()
Link to this type

state()

View Source

Specs

state() :: Ruler.State.t()
Link to this type

t()

View Source

Specs

t() :: %Ruler.Engine{
  instruction_queue: :queue.queue(instruction()),
  log: [log_event()],
  state: state()
}

Link to this section Functions

Link to this function

add_facts(engine, facts)

View Source

Specs

add_facts(t(), [fact()]) :: t()
Link to this function

add_instruction(engine, instruction)

View Source

Specs

add_instruction(t(), instruction()) :: t()
Link to this function

add_instructions(engine, instructions)

View Source

Specs

add_instructions(t(), [instruction()]) :: t()
Link to this function

add_log_event(engine, log_event)

View Source

Specs

add_log_event(t(), log_event()) :: t()
Link to this function

add_rules(engine, rules)

View Source

Specs

add_rules(t(), [rule()]) :: t()
Link to this function

choose_from_conflict_set(engine)

View Source

Specs

choose_from_conflict_set(t()) :: activation_event() | nil
Link to this function

commit_activation_event(engine, arg)

View Source

Specs

commit_activation_event(t(), activation_event()) :: t()
Link to this function

done?(engine)

View Source

Specs

done?(t()) :: boolean()
Link to this function

new()

View Source

Specs

new() :: t()
Link to this function

process_activation_event(engine, event)

View Source

Specs

process_activation_event(t(), activation_event()) :: t()
Link to this function

process_instruction(engine, arg)

View Source

Specs

process_instruction(t(), instruction()) :: t()
Link to this function

process_next_instruction_from_queue(engine)

View Source

Specs

process_next_instruction_from_queue(t()) :: {:ok, t()} | :done
Link to this function

query(engine, clauses)

View Source

Specs

query(t(), [Ruler.Clause.t()]) :: MapSet.t(Ruler.Activation.t())
Link to this function

remove_facts(engine, facts)

View Source

Specs

remove_facts(t(), [fact()]) :: t()
Link to this function

run_until_done(engine)

View Source

Specs

run_until_done(t()) :: t()
Link to this function

step(engine)

View Source

Specs

step(t()) :: {:ok, t()} | :done