diff --git a/chorus_book/src/header.txt b/chorus_book/src/header.txt index a12db21..1dbae7c 100644 --- a/chorus_book/src/header.txt +++ b/chorus_book/src/header.txt @@ -1,5 +1,5 @@ # extern crate chorus_lib; -# use chorus_lib::core::{ChoreoOp, Choreography, ChoreographyLocation, Projector, Located, MultiplyLocated, Superposition, Runner, LocationSet, Serialize, Deserialize}; +# use chorus_lib::core::{ChoreoOp, Choreography, ChoreographyLocation, Projector, Located, MultiplyLocated, Runner, LocationSet, Serialize, Deserialize}; # use chorus_lib::transport::local::{LocalTransport, LocalTransportChannelBuilder}; # #[derive(ChoreographyLocation)] # struct Alice; diff --git a/chorus_lib/src/core.rs b/chorus_lib/src/core.rs index 43b107c..2530665 100644 --- a/chorus_lib/src/core.rs +++ b/chorus_lib/src/core.rs @@ -466,12 +466,12 @@ pub trait ChoreoOp { Sender: Member, D: Subset; - /// TODO: documentation + /// Obtains a normal value from a value located at all locations in the census fn naked(&self, data: MultiplyLocated) -> V where ChoreoLS: Subset; - /// TODO: documentation + /// Wraps a value into a located value at the current census fn unnaked(&self, data: V) -> MultiplyLocated; /// Calls a choreography. @@ -547,7 +547,9 @@ pub trait FanOutChoreography { type L: LocationSet; /// Locations looping over type QS: LocationSet; - /// TODO: documentation + /// The body of the choreography defined in terms of the operators provided by `ChoreoOp` + /// + /// `Q` is the location that the loop variable and is guaranteed to be a member of `L` and `QS`. fn run( &self, op: &impl ChoreoOp, @@ -566,7 +568,9 @@ pub trait FanInChoreography { type QS: LocationSet; /// Recipient locations type RS: LocationSet; - /// run a choreography + /// The body of the choreography defined in terms of the operators provided by `ChoreoOp` + /// + /// `Q` is the location that the loop variable and is guaranteed to be a member of `L` and `QS`. fn run( &self, op: &impl ChoreoOp,