Struct fst::raw::Output
[−]
[src]
pub struct Output(_);
An output is a value that is associated with a key in a finite state transducer.
Note that outputs must satisfy an algebra. Namely, it must have an additive
identity and the following binary operations defined: prefix
,
concatenation
and subtraction
. prefix
and concatenation
are
commutative while subtraction
is not. subtraction
is only defined on
pairs of operands where the first operand is greater than or equal to the
second operand.
Currently, output values must be u64
. However, in theory, an output value
can be anything that satisfies the above algebra. Future versions of this
crate may make outputs generic on this algebra.
Methods
impl Output
[src]
fn new(v: u64) -> Output
Create a new output from a u64
.
fn zero() -> Output
Create a zero output.
fn value(self) -> u64
Retrieve the value inside this output.
fn is_zero(self) -> bool
Returns true if this is a zero output.
fn prefix(self, o: Output) -> Output
Returns the prefix of this output and o
.
fn cat(self, o: Output) -> Output
Returns the concatenation of this output and o
.
fn sub(self, o: Output) -> Output
Returns the subtraction of o
from this output.
This function panics if self > o
.
Trait Implementations
impl Copy for Output
[src]
impl Clone for Output
[src]
fn clone(&self) -> Output
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl Debug for Output
[src]
impl Hash for Output
[src]
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Eq for Output
[src]
impl Ord for Output
[src]
fn cmp(&self, __arg_0: &Output) -> Ordering
This method returns an Ordering
between self
and other
. Read more
impl PartialEq for Output
[src]
fn eq(&self, __arg_0: &Output) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Output) -> bool
This method tests for !=
.
impl PartialOrd for Output
[src]
fn partial_cmp(&self, __arg_0: &Output) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Output) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Output) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Output) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Output) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more