Skip to content

Commit

Permalink
Document And/Or vectors contain 2 elements
Browse files Browse the repository at this point in the history
It is not immediately obvious that the `Concrete::And` and `Or` vectors
contain exactly 2 elements, add code comment to document it.
  • Loading branch information
tcharding committed Sep 26, 2023
1 parent 3c6ae26 commit 47c8776
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/policy/concrete.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ const MAX_COMPILATION_LEAVES: usize = 1024;
/// Concrete policy which corresponds directly to a miniscript structure,
/// and whose disjunctions are annotated with satisfaction probabilities
/// to assist the compiler.
// Currently the vectors in And/Or are limited to two elements, this is a general miniscript thing
// not specific to rust-miniscript. Eventually we would like to extend these to be n-ary, but first
// we need to decide on a game plan for how to efficiently compile n-ary disjunctions
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Policy<Pk: MiniscriptKey> {
/// Unsatisfiable.
Expand Down

0 comments on commit 47c8776

Please sign in to comment.