Struct aegir::ops::Sign

pub struct Sign<N>(pub N);

Operator that applies f[g](x) = sgn(g(x)) to a buffer.

Examples

let f = Sign(X.into_var());

assert_eq!(f.evaluate_dual(X, ctx!{X = -1.0}).unwrap(), dual!(-1.0, 0.0));
assert_eq!(f.evaluate_dual(X, ctx!{X = 0.0}).unwrap(), dual!(0.0, INFINITY));
assert_eq!(f.evaluate_dual(X, ctx!{X = 1.0}).unwrap(), dual!(1.0, 0.0));

Tuple Fields

0: N

Trait Implementations

impl<N: Clone> Clone for Sign<N>

fn clone(&self) -> Sign<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, I: Identifier> Contains<I> for Sign<N>where
    N: Contains<I>,

fn contains(&self, target: I) -> bool

Returns true if the identifier is present in the expression.

impl<N: Debug> Debug for Sign<N>

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

Formats the value using the given formatter.

impl<T, N> Differentiable<T> for Sign<N>where
    T: Identifier,
    N: Differentiable<T> + Clone,

type Adjoint = Mul<Dirac<N>, <N as Differentiable<T>>::Adjoint>

The adjoint operator; i.e. the gradient.

fn adjoint(&self, target: T) -> Self::Adjoint

Transform the node into its Adjoint operator tree.

fn evaluate_adjoint<C: Context, CR: AsRef<C>>(
    &self,
    target: T,
    ctx: CR
) -> AegirResult<Self::Adjoint, C>where
    Self: Function<C>,
    Self::Adjoint: Function<C>,

Helper method that computes the adjoint and evaluates its value.

fn evaluate_dual<C: Context, CR: AsRef<C>>(
    &self,
    target: T,
    ctx: CR
) -> Result<DualOf<Self, C, T>, BinaryError<Self::Error, <AdjointOf<Self, T> as Function<C>>::Error, NoError>>where
    Self: Function<C>,
    Self::Adjoint: Function<C>,

Helper method that evaluates the function and its adjoint, wrapping up in a Dual.

impl<N: ToExpr> Display for Sign<N>

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

Formats the value using the given formatter.

impl<C, N, F> Function<C> for Sign<N>where
    C: Context,
    N: Function<C>,
    F: Scalar + Float,
    N::Value: Buffer<Field = F>,

type Error = <N as Function<C>>::Error

The error type of the function.

type Value = <N as Function<C>>::Value

The codomain of the function.

fn evaluate<CR: AsRef<C>>(&self, ctx: CR) -> Result<Self::Value, Self::Error>

Evaluate the function and return its Value.

fn evaluate_spec<CR: AsRef<C>>(
    &self,
    ctx: CR
) -> Result<Spec<Self::Value>, Self::Error>

Evaluate the function and return its lifted Value.

fn evaluate_shape<CR: AsRef<C>>(
    &self,
    ctx: CR
) -> Result<ShapeOf<Self::Value>, Self::Error>

Evaluate the function and return the shape of the Value.

impl<N: Node> Node for Sign<N>

fn add<N: Node>(self, other: N) -> Add<Self, N>where
    Self: Sized,

fn sub<N: Node>(self, other: N) -> Sub<Self, N>where
    Self: Sized,

fn mul<N: Node>(self, other: N) -> Mul<Self, N>where
    Self: Sized,

fn div<N: Node>(self, other: N) -> Div<Self, N>where
    Self: Sized,

fn dot<N: Node>(self, other: N) -> TensorDot<Self, N>where
    Self: Sized,

fn abs(self) -> Abs<Self>where
    Self: Sized,

fn neg(self) -> Negate<Self>where
    Self: Sized,

fn pow<P>(self, power: P) -> Power<Self, P>where
    Self: Sized,

fn ln(self) -> Ln<Self>where
    Self: Sized,

fn squared(self) -> Square<Self>where
    Self: Sized,

fn sum(self) -> Sum<Self>where
    Self: Sized,

fn sigmoid(self) -> Sigmoid<Self>where
    Self: Sized,

impl<N: PartialEq> PartialEq<Sign<N>> for Sign<N>

fn eq(&self, other: &Sign<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: ToExpr> ToExpr for Sign<N>

fn to_expr(&self) -> Expr

Convert the node to an expression string.

impl<N: Copy> Copy for Sign<N>

impl<N> StructuralPartialEq for Sign<N>