Skip to main content

Population

rlevo_evolution::population

Struct Population 

Source 
pub struct Population<B: Backend, K> { /* private fields */ }
Expand description

Population stored on a Burn backend device.

The concrete tensor type depends on the genome kind K. Most consumers interact with Population<B, Real> via tensor, but strategies parameterized on the kind can keep the K generic and reach for the right tensor flavor through the inherent impls below.

Invariant: for every Population<B, K> produced by the public constructors, exactly one of tensor_real / tensor_int is Some, determined by K. Real populates tensor_real; Binary, Integer, and Permutation populate tensor_int. The inherent tensor(&self) accessors .expect() on the matching field because the constructor contract pins the invariant — a mismatch would be a bug in this module.

Implementations§

Source§

impl<B: Backend, K> Population<B, K>

Source

pub fn pop_size(&self) -> usize

Returns the number of individuals (rows) in the population.

Source

pub fn genome_dim(&self) -> usize

Returns the genome dimensionality (columns).

Source§

impl<B: Backend> Population<B, Real>

Source

pub fn new_real(tensor: Tensor<B, 2>) -> Self

Constructs a real-valued population from a Tensor<B, 2>.

§Panics

Panics if the tensor is not rank 2.

Source

pub fn tensor(&self) -> &Tensor<B, 2>

Borrows the backing real-valued tensor.

§Panics

Never panics for a correctly constructed Population<B, Real>.

Source

pub fn into_tensor(self) -> Tensor<B, 2>

Consumes the wrapper and returns the owned tensor.

§Panics

Never panics for a correctly constructed Population<B, Real>.

Source§

impl<B: Backend> Population<B, Binary>

Source

pub fn new_binary(tensor: Tensor<B, 2, Int>) -> Self

Constructs a binary population from a Tensor<B, 2, Int>.

§Panics

Panics if the tensor is not rank 2.

Source

pub fn tensor(&self) -> &Tensor<B, 2, Int>

Borrows the backing integer tensor holding 0/1 values.

§Panics

Never panics for a correctly constructed Population<B, Binary>.

Source§

impl<B: Backend> Population<B, Integer>

Source

pub fn new_integer(tensor: Tensor<B, 2, Int>) -> Self

Constructs an integer population from a Tensor<B, 2, Int>.

§Panics

Panics if the tensor is not rank 2.

Source

pub fn tensor(&self) -> &Tensor<B, 2, Int>

Borrows the backing integer tensor.

§Panics

Never panics for a correctly constructed Population<B, Integer>.

Trait Implementations§

Source§

impl<B: Clone + Backend, K: Clone> Clone for Population<B, K>

Source§

fn clone(&self) -> Population<B, K>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<B: Debug + Backend, K: Debug> Debug for Population<B, K>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Adaptor<()> for T

Source§

fn adapt(&self)

Adapt the type to be passed to a metric.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoComptime for T

Source§

fn comptime(self) -> Self

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

Source§

impl<T> WasmNotSync for T
where T: Sync,