Skip to content

Commit

Permalink
add some minimal docs (based on #2230)
Browse files Browse the repository at this point in the history
  • Loading branch information
ctb committed Aug 18, 2024
1 parent eb8816d commit cc8dbc6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/core/src/collection.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ use crate::{Error, Result};
#[cfg(feature = "parallel")]
use rayon::prelude::*;

/// a Manifest and Storage, combined. Can contain any collection of signatures.
pub struct Collection {
manifest: Manifest,
storage: InnerStorage,
}

/// A consistent collection of signatures. Can be created using `select`.
pub struct CollectionSet {
collection: Collection,
}
Expand Down
2 changes: 2 additions & 0 deletions src/core/src/index/linear.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ use crate::sketch::Sketch;
use crate::storage::SigStore;
use crate::Result;

/// Supports parallel search without a particular index.
pub struct LinearIndex {
collection: CollectionSet,
template: Sketch,
Expand Down

0 comments on commit cc8dbc6

Please sign in to comment.