feagi-structures 0.0.1-beta.2

The most core library, defines the basic data types used by FEAGI, as well as some processors to modify them
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

# feagi-structures

**Core data structures and types for the FEAGI ecosystem**

[![Crates.io](https://img.shields.io/crates/v/feagi-structures.svg)](https://crates.io/crates/feagi-structures)
[![Documentation](https://docs.rs/feagi-structures/badge.svg)](https://docs.rs/feagi-structures)
[![License](https://img.shields.io/crates/l/feagi-structures.svg)](LICENSE)

## Overview

`feagi-data-structures` provides the foundational data types used throughout the FEAGI (Framework for Evolutionary Artificial General Intelligence) ecosystem. This crate defines core structures for genomic data, brain regions, cortical areas, and neuron voxels.

## Features

- **Genomic Data Structures**: Types for representing brain genome definitions
- **Brain Regions**: Hierarchical brain region organization with RegionID and RegionType
- **Cortical Areas**: Cortical area definitions with CorticalID and CorticalType
- **Neuron Voxels**: XYZP (X, Y, Z, Potential) neuron voxel representations
- **Templates**: Predefined templates for sensor and motor cortical units
- **Error Handling**: Comprehensive error types for data validation

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
feagi-structures = "0.0.1-beta.1"
```

## Usage

### Cortical Areas

```rust
use feagi-data-structures::genomic::cortical_area::{CorticalID, CorticalType};

// Create a cortical ID
let cortical_id = CorticalID::from_base_64("aXB1MDAw")?;

// Get the cortical type
let cortical_type = cortical_id.cortical_type();
```

### Brain Regions

```rust
use feagi_structures::genomic::brain_regions::{BrainRegion, RegionID, RegionType};

// Create a brain region
let region = BrainRegion::new(
    RegionID::new("vision"),
    "Visual Processing".to_string(),
    RegionType::Sensory
)?;
```

### Neuron Voxels

```rust
use feagi-data-structures::neuron_voxels::xyzp::NeuronVoxelXYZP;

// Create neuron voxels
let voxel = NeuronVoxelXYZP::new(10, 20, 5, 128);
```

## Documentation

For detailed API documentation, visit [docs.rs/feagi-data-structures](https://docs.rs/feagi-data-structures).

For conceptual documentation and guides, see the [docs/](docs/) directory.

## Part of FEAGI Ecosystem

This crate is part of the FEAGI project:

- **Main Project**: [feagi](https://crates.io/crates/feagi)
- **Data Serialization**: [feagi-serialization](https://crates.io/crates/feagi-serialization)
- **Sensorimotor**: [feagi-sensorimotor](https://crates.io/crates/feagi-sensorimotor)

## License

Licensed under the Apache License, Version 2.0. See [LICENSE](../../LICENSE) for details.

## Contributing

Contributions are welcome! Please see the [main repository](https://github.com/feagi/feagi-core) for contribution guidelines.

## Links

- **Homepage**: https://feagi.org
- **Repository**: https://github.com/feagi/feagi-core
- **Documentation**: https://docs.rs/feagi-data-structures
- **Issue Tracker**: https://github.com/feagi/feagi-core/issues