Skip to main content

NegEntropy

Struct NegEntropy 

Source
pub struct NegEntropy;
Expand description

Negative-entropy Bregman generator: (F(x) = \sum_i x_i \ln x_i), (\nabla F(x)_i = 1 + \ln x_i).

The Bregman divergence with this generator is the (unnormalized) KL divergence: (B_F(p, q) = \sum_i p_i \ln(p_i / q_i) - \sum_i (p_i - q_i)). When (p) and (q) are normalized (simplex), the second sum vanishes and (B_F = D_{KL}(p | q)).

This connects the information-theoretic (f-divergence) and geometric (Bregman) views of KL divergence. The dually-flat structure of the probability simplex under this generator is the foundation of information geometry (Amari & Nagaoka, 2000).

Trait Implementations§

Source§

impl BregmanGenerator for NegEntropy

Source§

fn f(&self, x: &[f64]) -> Result<f64>

Evaluate the potential (F(x)).
Source§

fn grad_into(&self, x: &[f64], out: &mut [f64]) -> Result<()>

Write (\nabla F(x)) into out.
Source§

impl Clone for NegEntropy

Source§

fn clone(&self) -> NegEntropy

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 Debug for NegEntropy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for NegEntropy

Source§

fn default() -> NegEntropy

Returns the “default value” for a type. Read more
Source§

impl Copy for NegEntropy

Auto Trait Implementations§

Blanket Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.