Enum ReduceOperation 

#[repr(i32)]
pub enum ReduceOperation {
    Sum = 0,
    Avg = 1,
    Prod = 2,
    Logsum = 3,
    Sumsquare = 4,
    L1 = 5,
    L2 = 6,
    Max = 7,
    Min = 8,
    Argmax = 9,
}

The following reduction operations are supported and are applied on the specified axis of the input array:

SUM Sum of all elements

 .. math:: \sum{x_i}

AVG Sum of all elements divided by the number of elements

 .. math:: \dfrac{\sum^n{x_i}}{n}

PROD Product of all elements

 .. math:: \prod{x_i}

LOGSUM Sum of the natural logarithm of all elements

 .. math:: \sum{\ln{(x_i + \epsilon)}}

SUMSQUARE Sum of squares of all elements

 .. math:: \sum{x^2}

L1 L1 normalization of all elements

 .. math:: ||x||_1 = \sum{|x_i|}

L2 L2 normalization of all elements

 .. math:: ||x||_2 = \sqrt{\sum{x_i^2}}

MAX Maximum of all elements

 .. math:: \text{max}(x_i)

MIN Minimum of all elements

 .. math:: \text{min}(x_i)

ARGMAX Argument of the maximum of all elements

 .. math:: \text{argmax}(x_i)

Variants

Sum = 0

Avg = 1

Prod = 2

Logsum = 3

Sumsquare = 4

L1 = 5

L2 = 6

Max = 7

Min = 8

Argmax = 9

only supported with axis = C, H or W.

Implementations

impl ReduceOperation

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of ReduceOperation.

pub fn from_i32(value: i32) -> Option<ReduceOperation>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a ReduceOperation, or None if value is not a valid variant.

impl ReduceOperation

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for ReduceOperation

fn clone(&self) -> ReduceOperation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReduceOperation

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

Formats the value using the given formatter.

impl Default for ReduceOperation

fn default() -> ReduceOperation

Returns the “default value” for a type.

impl From<ReduceOperation> for i32

fn from(value: ReduceOperation) -> i32

Converts to this type from the input type.

impl Hash for ReduceOperation

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 Ord for ReduceOperation

fn cmp(&self, other: &ReduceOperation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ReduceOperation

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ReduceOperation

fn partial_cmp(&self, other: &ReduceOperation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for ReduceOperation

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<ReduceOperation, UnknownEnumValue>

Performs the conversion.

impl Copy for ReduceOperation

impl Eq for ReduceOperation

impl StructuralPartialEq for ReduceOperation