morphology_registry (macula_tweann v0.18.1)

View Source

Registry for morphology modules.

Provides runtime registration of morphology implementations. Applications can register custom morphologies without modifying the macula-tweann library.

Usage:

Start registry (done automatically by application): morphology_registry:start_link().

Register a morphology: ok = morphology_registry:register(my_problem, my_morphology_module).

Get registered module: {ok, my_morphology_module} = morphology_registry:get(my_problem).

List all registered: [my_problem, xor_mimic] = morphology_registry:list_all().

Summary

Functions

get(MorphologyName)

Get the module for a registered morphology.

is_registered(MorphologyName)

Check if a morphology is registered.

list_all()

List all registered morphologies.

register(MorphologyName, Module)

Register a morphology module.

start_link()

Start the morphology registry server.

unregister(MorphologyName)

Unregister a morphology.

Functions

get(MorphologyName)

-spec get(atom()) -> {ok, module()} | {error, not_found}.

Get the module for a registered morphology.

is_registered(MorphologyName)

-spec is_registered(atom()) -> boolean().

Check if a morphology is registered.

list_all()

-spec list_all() -> [atom()].

List all registered morphologies.

register(MorphologyName, Module)

-spec register(atom(), module()) -> ok | {error, term()}.

Register a morphology module.

Verifies that the module implements morphology_behaviour before registering.

Example:

ok = morphology_registry:register(xor_mimic, morphology_xor).

start_link()

-spec start_link() -> {ok, pid()} | {error, term()}.

Start the morphology registry server.

Creates ETS table for storing morphology registrations.

unregister(MorphologyName)

-spec unregister(atom()) -> ok.

Unregister a morphology.