Struct BitString 

pub struct BitString { /* private fields */ }

Fixed-length bit string genome

This genome type represents binary optimization problems where solutions are vectors of boolean values.

Implementations

impl BitString

pub fn new(bits: Vec<bool>) -> Self

Create a new bit string with the given bits

pub fn zeros(length: usize) -> Self

Create an all-zeros bit string of the given length

pub fn ones(length: usize) -> Self

Create an all-ones bit string of the given length

pub fn generate_with_len<R: Rng>(rng: &mut R, len: usize) -> Self

Generate a random bit string of an explicit length.

This is the honest constructor for random generation: unlike EvolutionaryGenome::generate, which overloads MultiBounds and only reads its dimension count, this takes the number of bits directly.

pub fn from_u64(value: u64, length: usize) -> Self

Create a bit string from a u64 with the given length

pub fn to_u64(&self) -> Option<u64>

Convert to a u64 (only valid for length <= 64)

pub fn len(&self) -> usize

Get the length of the bit string

pub fn is_empty(&self) -> bool

Check if the bit string is empty

pub fn get(&self, index: usize) -> Option<bool>

Get a specific bit

pub fn set(&mut self, index: usize, value: bool)

Set a specific bit

pub fn flip(&mut self, index: usize)

Flip a specific bit

pub fn flip_all(&mut self)

Flip all bits

pub fn complement(&self) -> Self

Get the complement (all bits flipped)

pub fn hamming_distance(&self, other: &Self) -> usize

Hamming distance to another bit string.

Panics

Panics if the two bit strings have different lengths (an invariant violation). Use try_hamming_distance for a fallible variant.

pub fn try_hamming_distance(&self, other: &Self) -> Result<usize, GenomeError>

Fallible Hamming distance: returns Err(GenomeError::DimensionMismatch) when the two bit strings differ in length instead of silently truncating to the shorter one.

pub fn and(&self, other: &Self) -> Result<Self, GenomeError>

Bitwise AND with another bit string

pub fn or(&self, other: &Self) -> Result<Self, GenomeError>

Bitwise OR with another bit string

pub fn xor(&self, other: &Self) -> Result<Self, GenomeError>

Bitwise XOR with another bit string

Trait Implementations

impl BinaryGenome for BitString

fn bits(&self) -> &[bool]

Get the bits as a slice

fn bits_mut(&mut self) -> &mut [bool]

Get the bits as a mutable slice

fn from_bits(bits: Vec<bool>) -> Result<Self, GenomeError>

Create from a vector of bits

fn count_ones(&self) -> usize

Count the number of true bits (ones)

fn count_zeros(&self) -> usize

Count the number of false bits (zeros)

impl Clone for BitString

fn clone(&self) -> BitString

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CrossoverOperator<BitString> for UniformCrossover

fn crossover<R: Rng>( &self, parent1: &BitString, parent2: &BitString, rng: &mut R, ) -> OperatorResult<(BitString, BitString)>

Apply crossover to two parents and produce two offspring

fn crossover_probability(&self) -> f64

Get the probability of crossover being applied

impl CrossoverOperator<BitString> for OnePointCrossover

fn crossover<R: Rng>( &self, parent1: &BitString, parent2: &BitString, rng: &mut R, ) -> OperatorResult<(BitString, BitString)>

Apply crossover to two parents and produce two offspring

fn crossover_probability(&self) -> f64

Get the probability of crossover being applied

impl CrossoverOperator<BitString> for TwoPointCrossover

fn crossover<R: Rng>( &self, parent1: &BitString, parent2: &BitString, rng: &mut R, ) -> OperatorResult<(BitString, BitString)>

Apply crossover to two parents and produce two offspring

fn crossover_probability(&self) -> f64

Get the probability of crossover being applied

impl Debug for BitString

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BitString

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BitString

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for BitString

impl EvolutionaryGenome for BitString

fn generate<R: Rng>(rng: &mut R, bounds: &MultiBounds) -> Self

Generate a random bit string.

Only bounds.dimension() is consulted — it is the number of bits — and the per-dimension min/max values are ignored. Prefer BitString::generate_with_len to make the length explicit.

type Allele = bool

The allele type for individual genes

type Phenotype = Vec<bool>

The phenotype or decoded solution type

fn decode(&self) -> Self::Phenotype

Decode genome into phenotype for fitness evaluation

fn dimension(&self) -> usize

Compute dimensionality for adaptive operators

fn as_slice(&self) -> Option<&[bool]>

Get the genome’s genes as a slice (for numeric genomes)

fn as_mut_slice(&mut self) -> Option<&mut [bool]>

Get the genome’s genes as a mutable slice (for numeric genomes)

fn distance(&self, other: &Self) -> f64

Distance metric between two genomes.

fn try_distance(&self, other: &Self) -> Result<f64, GenomeError>

Fallible distance metric.

impl From<BitString> for Vec<bool>

fn from(genome: BitString) -> Self

Converts to this type from the input type.

impl From<Vec<bool>> for BitString

fn from(bits: Vec<bool>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[bool; N]> for BitString

fn from(arr: [bool; N]) -> Self

Converts to this type from the input type.

impl Hash for BitString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for BitString

type Output = bool

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IntoIterator for BitString

type Item = bool

The type of the elements being iterated over.

type IntoIter = IntoIter<bool>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a BitString

type Item = &'a bool

The type of the elements being iterated over.

type IntoIter = Iter<'a, bool>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl MutationOperator<BitString> for BitFlipMutation

fn mutate<R: Rng>(&self, genome: &mut BitString, rng: &mut R)

Apply mutation to a genome in place

fn mutation_probability(&self) -> Option<f64>

Report the per-gene mutation probability actually applied by this operator.

impl MutationOperator<BitString> for SwapMutation

fn mutate<R: Rng>(&self, genome: &mut BitString, rng: &mut R)

Apply mutation to a genome in place

fn mutation_probability(&self) -> Option<f64>

Report the per-gene mutation probability actually applied by this operator.

impl MutationOperator<BitString> for ScrambleMutation

fn mutate<R: Rng>(&self, genome: &mut BitString, rng: &mut R)

Apply mutation to a genome in place

fn mutation_probability(&self) -> Option<f64>

Report the per-gene mutation probability actually applied by this operator.

impl PartialEq for BitString

fn eq(&self, other: &BitString) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for BitString

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BitString

impl TraceGenome for BitString

Available on crate feature ppl only.

fn to_trace(&self) -> Trace

Convert BitString to Fugue trace.

Each bit is stored at address “bit#i” where i is the index.

fn from_trace(trace: &Trace) -> Result<Self, GenomeError>

Reconstruct BitString from Fugue trace.

Reads bits from addresses “bit#0”, “bit#1”, … until no more are found. A missing address terminates the scan (normal end of the sequence), but an address that is present with the wrong value type is a corrupt trace and yields GenomeError::TypeMismatch rather than silently truncating.

fn trace_prefix() -> &'static str

Get the address prefix used for trace storage (default: "gene").