Struct Classifier 

pub struct Classifier {

    pub classifier_id: String,
    pub name: String,
    pub parent_region_id: String,
    pub coordinates_3d: [i32; 3],
    pub sample_area_ids: Vec<String>,
    pub class_bindings: Vec<ClassifierClassBinding>,
    pub sample_memory_id: String,
    pub class_memory_id: String,
    pub error_area_id: String,
    pub correct_area_id: String,
    pub reward_training: bool,
    pub answer_feedback_area_id: Option<String>,
    pub reward_modulator_ids: Vec<String>,
    pub answer_latency_bursts: u32,
    pub learn_area_id: Option<String>,
    pub confidence_area_id: Option<String>,
    pub properties: HashMap<String, Value>,
}

First-class classifier record persisted in the genome.

Fields

classifier_id: String

UUID string, genome map key.

name: String

parent_region_id: String

Circuit region that contains this assembly.

That region is a child of the region the user added the classifier to, and that parent may be root. The memory and error areas belong to this circuit, not to root.

coordinates_3d: [i32; 3]

sample_area_ids: Vec<String>

Episodic sample inputs on the sample memory. Order is not significant.

class_bindings: Vec<ClassifierClassBinding>

Episodic class inputs and the output created for each one.

sample_memory_id: String

Owned sample memory. Deleting it deletes the classifier.

class_memory_id: String

Owned class memory. Deleting it deletes the classifier.

error_area_id: String

Owned 1x1x1 area. Fires when any class output mismatches its class input or has more than one firing neuron.

correct_area_id: String

Owned 1x1x1 area. Fires when every firing class input is answered by its class output and no output raises the error. Empty on classifiers created before it existed.

reward_training: bool

Per-pattern pain and pleasure on the associative mapping.

answer_feedback_area_id: Option<String>

Correct-answer area. Empty until the user selects one.

reward_modulator_ids: Vec<String>

synaptic.reward modulators the associative mapping learns from (R-STDP). The classifier’s own right-answer and wrong-answer modulators are listed here like any other source.

answer_latency_bursts: u32

Bursts between a decision and the answer that grades it. Zero grades the same burst.

learn_area_id: Option<String>

When set, pain and pleasure run only on bursts this area fires.

confidence_area_id: Option<String>

OPU that receives one surplus value per class channel.

properties: HashMap<String, Value>

Implementations

impl Classifier

pub fn assembly_core_ids(&self) -> Vec<String>

Sample memory and class memory. Deleting either deletes the assembly.

pub fn owned_area_ids(&self) -> Vec<String>

Owned internals deleted with the classifier.

pub fn input_area_ids(&self) -> Vec<String>

Referenced input areas that may be cleared independently.

pub fn clear_answer_area(&mut self, area_id: &str) -> bool

Forget a deleted error or correct area. Returns true when area_id was one of them. The next reward update creates the area again.

pub fn owns_assembly_core(&self, area_id: &str) -> bool

pub fn owns_area(&self, area_id: &str) -> bool

True when area_id is sample memory, class memory, the error area, or a class output.

pub fn binding_for_class( &self, class_area_id: &str, ) -> Option<&ClassifierClassBinding>

pub fn binding_for_output( &self, output_area_id: &str, ) -> Option<&ClassifierClassBinding>

pub fn references_input(&self, area_id: &str) -> bool

True when area_id is a referenced sample or class input of this classifier.

pub fn apply_metadata_update( &mut self, name: Option<String>, coordinates_3d: Option<[i32; 3]>, ) -> Result<(), String>

Apply classifier-level metadata. Does not change owned internals or inputs.

pub fn apply_assembly_update( &mut self, name: Option<String>, coordinates_3d: Option<[i32; 3]>, parent_region_id: Option<String>, ) -> Result<(), String>

Apply classifier-level edit. Does not replace owned internals or input bindings.

pub fn required_mappings(&self) -> Vec<ClassifierMapping>

Mappings this classifier requires given its current inputs.

pub fn clear_input(&mut self, area_id: &str) -> Option<String>

Drop an input reference when that area is deleted.

Returns the class output id that must be deleted with a removed class input.

pub fn attach_sample(&mut self, sample_area_id: String) -> Result<(), String>

Record one sample input. A second call for the same area is a no-op success.

pub fn detach_sample(&mut self, sample_area_id: &str) -> bool

Remove one sample input.

pub fn attach_class( &mut self, class_area_id: String, class_output_area_id: String, ) -> Result<(), String>

Record one class input and its output. The output id may be filled after the area exists.

pub fn set_class_output( &mut self, class_area_id: &str, class_output_area_id: String, ) -> Result<(), String>

Fill the output id for a class input that was recorded before the area existed.

pub fn detach_class(&mut self, class_area_id: &str) -> Option<String>

Remove one class binding. Returns the output area id when one was recorded.

pub fn apply_mapping_change( &mut self, src_area_id: &str, dst_area_id: &str, morphology_id: &str, removed: bool, ) -> Result<ClassifierMappingEffect, String>

Bind or clear sample and class inputs from a mapping change.

applied is false when the edge does not belong to this classifier. removed_output_id is set when a class input mapping is removed.

Trait Implementations

impl Clone for Classifier

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Classifier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Classifier

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Classifier

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Classifier

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Classifier