Struct xor_distance_exercise::bits::Bits

pub struct Bits { /* private fields */ }

Bits representation.

Examples

extern crate xor_distance_exercise;

use xor_distance_exercise::bits::Bits;

// Find out bit size of specific integer type.
let size = Bits::bit_size::<i64>();

// Bit representation of `u64` integer.
let mut bit_rep = Bits::new::<u64>();

// Operations on the bit representation.
let bit = bit_rep.get_bit(4);
bit_rep.set_bit(4, true);
bit_rep.set_bit_within_constrains(5, true);
bit_rep.is_bit_decided(4);
let number = bit_rep.form_zero_padded_number::<u64>().unwrap();

Implementations

impl Bits

pub fn new<T: PrimInt>() -> Self

Create a new representation of Bits.

Examples

extern crate xor_distance_exercise;

use xor_distance_exercise::bits::Bits;

let bit_rep = Bits::new::<u64>;

pub fn bit_size<T: PrimInt>() -> usize

Return bit size of the type being represented in bits.

Examples

extern crate xor_distance_exercise;

use xor_distance_exercise::bits::Bits;

assert_eq!(8, Bits::bit_size::<u8>());
assert_eq!(32, Bits::bit_size::<u32>());
assert_eq!(64, Bits::bit_size::<u64>());
assert_eq!(64, Bits::bit_size::<i64>());

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

Get bit value for the index.

Examples

extern crate xor_distance_exercise;

use xor_distance_exercise::bits::Bits;

let bit_rep = Bits::new::<u64>();
let bit = bit_rep.get_bit(4);

Panics

Panics if index is out of range.

pub fn set_bit(&mut self, index: usize, val: bool)

Set new bit value for the index.

Examples

extern crate xor_distance_exercise;

use xor_distance_exercise::bits::Bits;

let mut bit_rep = Bits::new::<u64>();
bit_rep.set_bit(4, true);
bit_rep.set_bit(5, false);

Panics

Panics if index is out of range.

pub fn set_bit_within_constrains(
    &mut self,
    index: usize,
    val: bool
) -> Result<(), &'static str>

Set new bit value complying with constrains, already decided bit value can not be changed.

Returns Ok(()) in case constrains were not violated, Err(&str) otherwise.

Examples

extern crate xor_distance_exercise;

use xor_distance_exercise::bits::Bits;

let mut bit_rep = Bits::new::<u64>();
bit_rep.set_bit_within_constrains(4, true);

Panics

Panics if index is out of range.

pub fn is_bit_decided(&self, index: usize) -> bool

Is bit decided already?

Examples

extern crate xor_distance_exercise;

use xor_distance_exercise::bits::Bits;

let bit_rep = Bits::new::<u64>();
bit_rep.is_bit_decided(4);

Panics

Panics if index is out of range.

pub fn form_zero_padded_number<T: PrimInt>(&self) -> Result<T, &str>

Form and return a number based on bits representation, pad/fill undecided bits by zeros.

Examples

extern crate xor_distance_exercise;

use xor_distance_exercise::bits::Bits;

let bit_rep = Bits::new::<u64>();
let number = bit_rep.form_zero_padded_number::<u64>().unwrap();