Struct malachite_base::num::random::striped::StripedBitSource

source · 
pub struct StripedBitSource { /* private fields */ }
Expand description

Generates bits from a striped random sequence.

See here for more information.

Implementations§

Creates a new StripedBitSource.

The mean run length is $m$, where $m$ is m_numerator / m_denominator.

Expected complexity

Constant time and additional memory.

Panics

Panics if m_denominator is zero or if m_numerator <= m_denominator.

Examples
use malachite_base::num::random::striped::StripedBitSource;
use malachite_base::random::EXAMPLE_SEED;

let mut bit_source = StripedBitSource::new(EXAMPLE_SEED, 4, 1);
let mut string = String::with_capacity(40);
for bit in bit_source.take(40) {
    if bit {
        string.push('1');
    } else {
        string.push('0');
    }
}
assert_eq!(string, "0000000101100110000000011110000000001111");

Resets this StripedBitSource, so that the next time next is called, the probabilities of true or false will be equal.

Expected complexity

Constant time and additional memory.

Examples
use malachite_base::num::random::striped::StripedBitSource;
use malachite_base::random::EXAMPLE_SEED;

fn generate_string(bit_source: &mut StripedBitSource) -> String {
    let mut string = String::with_capacity(40);
    for bit in bit_source.take(40) {
        if bit {
            string.push('1');
        } else {
            string.push('0');
        }
    }
    string
}

let mut bit_source = StripedBitSource::new(EXAMPLE_SEED, 1000000, 1);
let mut strings = Vec::with_capacity(5);
for _ in 0..5 {
    strings.push(generate_string(&mut bit_source));
    bit_source.end_block();
}
assert_eq!(
    strings,
    &[
        "0000000000000000000000000000000000000000",
        "0000000000000000000000000000000000000000",
        "0000000000000000000000000000000000000000",
        "1111111111111111111111111111111111111111",
        "0000000000000000000000000000000000000000"
    ]
);

Sets the previous bit of a StripedBitSource. This will affect the probability of the next bit.

Expected complexity

Constant time and additional memory.

Examples
use malachite_base::num::random::striped::StripedBitSource;
use malachite_base::random::EXAMPLE_SEED;

fn generate_string(bit_source: &mut StripedBitSource) -> String {
    let mut string = String::with_capacity(40);
    for bit in bit_source.take(40) {
        if bit {
            string.push('1');
        } else {
            string.push('0');
        }
    }
    string
}

let mut bit_source = StripedBitSource::new(EXAMPLE_SEED, 1000000, 1);
bit_source.next();
let mut strings = Vec::with_capacity(3);
bit_source.set_previous_bit(true);
strings.push(generate_string(&mut bit_source));
bit_source.set_previous_bit(false);
strings.push(generate_string(&mut bit_source));
bit_source.set_previous_bit(true);
strings.push(generate_string(&mut bit_source));
assert_eq!(
    strings,
    &[
        "1111111111111111111111111111111111111111",
        "0000000000000000000000000000000000000000",
        "1111111111111111111111111111111111111111",
    ]
);

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more

Gets a bit from this StripedBitSource. If this function is being called for the first time, the probabilities of a true or a false are equal. On subsequent calls, the probability of getting a bit different from the previous one is $1 / m$.

To reset the bit source, so that the next call to next has equal probabilities of true or false, call end_block.

Expected complexity

Constant time and additional memory.

The type of the elements being iterated over.
🔬This is a nightly-only experimental API. (iter_next_chunk)
Advances the iterator and returns an array containing the next N values. Read more
Returns the bounds on the remaining length of the iterator. Read more
Consumes the iterator, counting the number of iterations and returning it. Read more
Consumes the iterator, returning the last element. Read more
🔬This is a nightly-only experimental API. (iter_advance_by)
Advances the iterator by n elements. Read more
Returns the nth element of the iterator. Read more
Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
Takes two iterators and creates a new iterator over both in sequence. Read more
‘Zips up’ two iterators into a single iterator of pairs. Read more
🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places an item generated by separator between adjacent items of the original iterator. Read more
Takes a closure and creates an iterator which calls that closure on each element. Read more
Calls a closure on each element of an iterator. Read more
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
Creates an iterator that both filters and maps. Read more
Creates an iterator which gives the current iteration count as well as the next value. Read more
Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more
Creates an iterator that skips elements based on a predicate. Read more
Creates an iterator that yields elements based on a predicate. Read more
Creates an iterator that both yields elements based on a predicate and maps. Read more
Creates an iterator that skips the first n elements. Read more
Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner. Read more
An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator. Read more
Creates an iterator that works like map, but flattens nested structure. Read more
Creates an iterator which ends after the first None. Read more
Does something with each element of an iterator, passing the value on. Read more
Borrows an iterator, rather than consuming it. Read more
Transforms an iterator into a collection. Read more
🔬This is a nightly-only experimental API. (iter_collect_into)
Collects all the items from an iterator into a collection. Read more
Consumes an iterator, creating two collections from it. Read more
🔬This is a nightly-only experimental API. (iter_is_partitioned)
Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false. Read more
An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
Folds every element into an accumulator by applying an operation, returning the final result. Read more
Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
🔬This is a nightly-only experimental API. (iterator_try_reduce)
Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more
Tests if every element of the iterator matches a predicate. Read more
Tests if any element of the iterator matches a predicate. Read more
Searches for an element of an iterator that satisfies a predicate. Read more
Applies function to the elements of iterator and returns the first non-none result. Read more
🔬This is a nightly-only experimental API. (try_find)
Applies function to the elements of iterator and returns the first true result or the first error. Read more
Searches for an element in an iterator, returning its index. Read more
Returns the element that gives the maximum value from the specified function. Read more
Returns the element that gives the maximum value with respect to the specified comparison function. Read more
Returns the element that gives the minimum value from the specified function. Read more
Returns the element that gives the minimum value with respect to the specified comparison function. Read more
Converts an iterator of pairs into a pair of containers. Read more
Creates an iterator which copies all of its elements. Read more
Creates an iterator which clones all of its elements. Read more
Repeats an iterator endlessly. Read more
🔬This is a nightly-only experimental API. (iter_array_chunks)
Returns an iterator over N elements of the iterator at a time. Read more
Sums the elements of an iterator. Read more
Iterates over the entire iterator, multiplying all the elements Read more
🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
Lexicographically compares the elements of this Iterator with those of another. Read more
🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
Determines if the elements of this Iterator are equal to those of another. Read more
🔬This is a nightly-only experimental API. (iter_order_by)
Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function. Read more
Determines if the elements of this Iterator are unequal to those of another. Read more
Determines if the elements of this Iterator are lexicographically less than those of another. Read more
Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more
Determines if the elements of this Iterator are lexicographically greater than those of another. Read more
Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more
🔬This is a nightly-only experimental API. (is_sorted)
Checks if the elements of this iterator are sorted using the given comparator function. Read more
🔬This is a nightly-only experimental API. (is_sorted)
Checks if the elements of this iterator are sorted using the given key extraction function. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type of the elements being iterated over.
Which kind of iterator are we turning this into?
Creates an iterator from a value. Read more
Choose one element at random from the iterator. Read more
Collects values at random from the iterator into a supplied buffer until that buffer is filled. Read more
Collects amount values at random from the iterator into a vector. Read more
Alternate elements from two iterators until both have run out. Read more
Alternate elements from two iterators until at least one of them has run out. Read more
An iterator adaptor to insert a particular value between each element of the adapted iterator. Read more
Create an iterator which iterates over both this and the specified iterator simultaneously, yielding pairs of two optional elements. Read more
Create an iterator which iterates over both this and the specified iterator simultaneously, yielding pairs of elements. Read more
A “meta iterator adaptor”. Its closure receives a reference to the iterator and may pick off as many elements as it likes, to produce the next iterator element. Read more
Return an iterable that can group iterator elements. Consecutive elements that map to the same key (“runs”), are assigned to the same group. Read more
Return an iterable that can chunk the iterator. Read more
Return an iterator over all contiguous windows producing tuples of a specific size (up to 4). Read more
Return an iterator that groups the items in tuples of a specific size (up to 4). Read more
Split into an iterator pair that both yield all elements from the original iterator. Read more
👎Deprecated since 0.8: Use std .step_by() instead
Return an iterator adaptor that steps n elements in the base iterator for each iteration. Read more
Convert each item of the iterator using the Into trait. Read more
Return an iterator adaptor that applies the provided closure to every Result::Ok value. Result::Err values are unchanged. Read more
Return an iterator adaptor that merges the two base iterators in ascending order. If both base iterators are sorted (ascending), the result is sorted. Read more
Return an iterator adaptor that merges the two base iterators in order. This is much like .merge() but allows for a custom ordering. Read more
Create an iterator that merges items from both this and the specified iterator in ascending order. Read more
Return an iterator adaptor that flattens an iterator of iterators by merging them in ascending order. Read more
Return an iterator adaptor that flattens an iterator of iterators by merging them according to the given closure. Read more
Return an iterator adaptor that iterates over the cartesian product of the element sets of two iterators self and J. Read more
Return an iterator adaptor that iterates over the cartesian product of all subiterators returned by meta-iterator self. Read more
Return an iterator adaptor that uses the passed-in closure to optionally merge together consecutive elements. Read more
Remove duplicates from sections of consecutive identical elements. If the iterator is sorted, all elements will be unique. Read more
Remove duplicates from sections of consecutive identical elements, determining equality using a comparison function. If the iterator is sorted, all elements will be unique. Read more
Return an iterator adaptor that filters out elements that have already been produced once during the iteration. Duplicates are detected using hash and equality. Read more
Return an iterator adaptor that filters out elements that have already been produced once during the iteration. Read more
Return an iterator adaptor that borrows from this iterator and takes items while the closure accept returns true. Read more
Return an iterator adaptor that borrows from a Clone-able iterator to only pick off elements while the predicate accept returns true. Read more
Return an iterator adaptor that filters Option<A> iterator elements and produces A. Stops on the first None encountered. Read more
Return an iterator adaptor that iterates over the combinations of the elements from an iterator. Read more
Return an iterator adaptor that iterates over the k-length combinations of the elements from an iterator. Read more
Return an iterator that iterates over the k-length combinations of the elements from an iterator, with replacement. Read more
Return an iterator adaptor that iterates over all k-permutations of the elements from an iterator. Read more
Return an iterator adaptor that pads the sequence to a minimum length of min by filling missing elements using a closure f. Read more
Return an iterator adaptor that wraps each element in a Position to ease special-case handling of the first or last elements. Read more
Return an iterator adaptor that yields the indices of all elements satisfying a predicate, counted from the start of the iterator. Read more
Return an iterator adaptor that applies a mutating function to each element before yielding it. Read more
Advances the iterator and returns the next items grouped in a tuple of a specific size (up to 4). Read more
Collects all items from the iterator into a tuple of a specific size (up to 4). Read more
Find the position and value of the first element satisfying a predicate. Read more
Check whether all elements compare equal. Read more
Consume the first n elements from the iterator eagerly, and return the same iterator again. Read more
Consume the last n elements from the iterator eagerly, and return the same iterator again. Read more
👎Deprecated since 0.8: Use .for_each() instead
Run the closure f eagerly on each element of the iterator. Read more
Combine all an iterator’s elements into one element by using Extend. Read more
.collect_vec() is simply a type specialization of .collect(), for convenience.
.try_collect() is more convenient way of writing .collect::<Result<_, _>>() Read more
Assign to each reference in self from the from iterator, stopping at the shortest of the two iterators. Read more
Combine all iterator elements into one String, separated by sep. Read more
Format all iterator elements, separated by sep. Read more
Format all iterator elements, separated by sep. Read more
Fold Result values from an iterator. Read more
Fold Option values from an iterator. Read more
Accumulator of the elements in the iterator. Read more
Accumulate the elements in the iterator in a tree-like manner. Read more
👎Deprecated since 0.8: Use .try_fold() instead
An iterator method that applies a function, producing a single, final value. Read more
Iterate over the entire iterator and add all the elements. Read more
Iterate over the entire iterator and multiply all the elements. Read more
Sort all iterator elements into a new iterator in ascending order. Read more
Sort all iterator elements into a new iterator in ascending order. Read more
Sort all iterator elements into a new iterator in ascending order. Read more
Collect all iterator elements into one of two partitions. Unlike Iterator::partition, each partition may have a distinct type. Read more
Return a HashMap of keys mapped to Vecs of values. Keys and values are taken from (Key, Value) tuple pairs yielded by the input iterator. Read more
Return the minimum and maximum elements in the iterator. Read more
Return the minimum and maximum element of an iterator, as determined by the specified function. Read more
Return the minimum and maximum element of an iterator, as determined by the specified comparison function. Read more
Return the position of the maximum element in the iterator. Read more
Return the position of the maximum element in the iterator, as determined by the specified function. Read more
Return the position of the maximum element in the iterator, as determined by the specified comparison function. Read more
Return the position of the minimum element in the iterator. Read more
Return the position of the minimum element in the iterator, as determined by the specified function. Read more
Return the position of the minimum element in the iterator, as determined by the specified comparison function. Read more
Return the positions of the minimum and maximum elements in the iterator. Read more
Return the postions of the minimum and maximum elements of an iterator, as determined by the specified function. Read more
Return the postions of the minimum and maximum elements of an iterator, as determined by the specified comparison function. Read more
If the iterator yields exactly one element, that element will be returned, otherwise an error will be returned containing an iterator that has the same output as the input iterator. Read more
Should always be Self

Returns the String produced by Ts Debug implementation.

Examples
use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.