openbraininstitute / libsonata / 15489935130

93%

push

github

CompartmentSets (#4)

CompartmentSets

- [x] add CompartmentSets https://github.com/openbraininstitute/sonata-extension/pull/5

## API

### CompartmentLocation
- [x] init(name: str)  
- [x] init(gid: int64, section_idx: int64, offset: float)  
- [x] gid (property) -> int64  
- [x] section_idx (property) -> int64  
- [x] offset (property) -> float  
- [x] toJSON() -> str  
- [x] __iter__() -> tuple(gid, section_idx, offset)  
- [x] __eq__(other: CompartmentLocation) -> bool  
- [x] __ne__(other: CompartmentLocation) -> bool  
- [x] __copy__() -> CompartmentLocation  
- [x] __deepcopy__(memo: dict) -> CompartmentLocation  
- [x] __repr__() -> str  
- [x] __str__() -> str  

### CompartmentSet
- [x] init(name: str)  
- [x] population (property) -> int  
- [x] size(selection=Selection()) -> int  
- [x] gids() -> List[int]  
- [x] filter(selection=Selection()) -> CompartmentSet  
- [x] filtered_iter(selection=Selection()) -> Iterator[Compartment]  
- [x] __len__() -> int  
- [x] __getitem__(index: int) -> Compartment  
- [x] __iter__() -> Iterator[Compartment]  
- [x] __eq__(other: CompartmentSet) -> bool  
- [x] __ne__(other: CompartmentSet) -> bool  
- [x] toJSON() -> str  
- [x] __repr__() -> str  
- [x] __str__() -> str  

### CompartmentSets
- [x] init  
- [x] fromFile(path: str) -> CompartmentSets  
- [x] at(key: str) -> CompartmentSet  
- [x] __contains__(key: str) -> bool  
- [x] names() -> List[str]  
- [x] values() -> List[CompartmentSet]  
- [x] items() -> List[Tuple[str, CompartmentSet]]  
- [x] toJSON() -> str  
- [x] __eq__(other: CompartmentSets) -> bool  
- [x] __ne__(other: CompartmentSets) -> bool  
- [x] __len__() -> int  
- [x] __getitem__(key: str) -> CompartmentSet  
- [x] __repr__() -> str  
- [x] __str__() -> str  

## Additional changes
- [x] add contains and its python api. Example `3 in Selection([0, 1, 2, 3]) == True`
- [x] ctests
- [ ] ~~python tests~~ I cannot find python tests for Selection at all. I will not add a full test ... (continued)

293 of 324 new or added lines in 4 files covered. (90.43%)

2324 of 2510 relevant lines covered (92.59%)

39.37 hits per line