Struct moore_vhdl::ty2::FloatingBasetype

pub struct FloatingBasetype { /* fields omitted */ }

A real base type.

Methods

impl FloatingBasetype

pub fn new(range: Range<f64>) -> FloatingBasetype

Create a new real type.

Example

use moore_vhdl::ty2::{Type, FloatingBasetype, Range, RangeDir};

let a = FloatingBasetype::new(Range::ascending(0, 42));
let b = FloatingBasetype::new(Range::descending(42, 0));

assert_eq!(format!("{}", a), "0 to 42");
assert_eq!(format!("{}", b), "42 downto 0");
assert_eq!(a.dir(), RangeDir::To);
assert_eq!(b.dir(), RangeDir::Downto);
assert_eq!(a.len(), 43 as f64);
assert_eq!(b.len(), 43 as f64);

Methods from Deref<Target = Range<f64>>

pub fn dir(&self) -> RangeDir

Return the direction of the range.

Example

use moore_vhdl::ty2::{IntegerRange, RangeDir};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.dir(), RangeDir::To);
assert_eq!(b.dir(), RangeDir::Downto);

pub fn left(&self) -> &T

Return the left bound of the range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.left(), &BigInt::from(0));
assert_eq!(b.left(), &BigInt::from(42));

pub fn right(&self) -> &T

Return the right bound of the range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.right(), &BigInt::from(42));
assert_eq!(b.right(), &BigInt::from(0));

pub fn lower(&self) -> &T

Return the lower bound of the range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.lower(), &BigInt::from(0));
assert_eq!(b.lower(), &BigInt::from(0));

pub fn upper(&self) -> &T

Return the upper bound of the range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::descending(42, 0);

assert_eq!(a.upper(), &BigInt::from(42));
assert_eq!(b.upper(), &BigInt::from(42));

pub fn is_null(&self) -> bool

Return true if the range is a null range.

A null range has its lower bound greater than or equal to its upper bound, and thus also a length of 0 or lower.

Example

use moore_vhdl::ty2::IntegerRange;

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::ascending(42, 0);

assert_eq!(a.is_null(), false);
assert_eq!(b.is_null(), true);

pub fn len(&self) -> T

Return the length of the range.

The length of a range is defined as upper + 1 - lower. The result may be negative, indicating that the range is a null range.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::ascending(42, 0);

assert_eq!(a.len(), BigInt::from(43));
assert_eq!(b.len(), BigInt::from(-41));

pub fn has_subrange(&self, subrange: &Self) -> bool

Check if another range is a subrange of this range.

This function checks if self.lower() is less than or equal to, and self.upper() is larger than or equal to, the corresponding bounds of the subrange.

Example

use moore_vhdl::ty2::{IntegerRange, BigInt};

let a = IntegerRange::ascending(0, 42);
let b = IntegerRange::ascending(4, 16);
let c = IntegerRange::descending(16, 4);

assert_eq!(a.has_subrange(&b), true);
assert_eq!(a.has_subrange(&c), true);
assert_eq!(b.has_subrange(&a), false);
assert_eq!(c.has_subrange(&a), false);
assert_eq!(b.has_subrange(&c), true);
assert_eq!(c.has_subrange(&b), true);

pub fn contains(&self, value: &T) -> bool

Check if a value is within this range.

This function checks if self.lower() is less than or equal to, and self.upper() is larger than or equal to, the given value.

Trait Implementations

impl<'a, 't> Alloc<'a, 'a, FloatingBasetype> for TypeArena<'t> where     't: 'a,

fn alloc(&'a self, value: FloatingBasetype) -> &'a mut FloatingBasetype

Allocate a value of type T.

impl Type for FloatingBasetype

fn is_scalar(&self) -> bool

Check if this is a scalar type.

fn is_discrete(&self) -> bool

Check if this is a discrete type.

fn is_numeric(&self) -> bool

Check if this is a numeric type.

fn is_composite(&self) -> bool

Check if this is a composite type.

fn as_any(&self) -> AnyType

Converts from &Type to AnyType.

fn into_owned<'a>(self) -> OwnedType<'a> where     Self: 'a,

Convert into an owned type.

fn to_owned<'a>(&self) -> OwnedType<'a> where     Self: 'a,

Clone this type.

fn is_equal(&self, other: &dyn Type) -> bool

Check if two types are equal.

fn is_implicitly_castable(&self, _into: &dyn Type) -> bool

Check if the type can be implicitly cast to another.

impl FloatingType for FloatingBasetype

fn as_type(&self) -> &dyn Type

Convert to a type.

fn range(&self) -> Option<&Range<f64>>

The range of values this real can assume.

fn base_type(&self) -> &dyn Type

The base type of this real.

fn as_basetype(&self) -> Option<&FloatingBasetype>

Returns Some if self is an FloatingBasetype, None otherwise.

fn is_equal(&self, other: &dyn FloatingType) -> bool

Check if two real types are equal.

fn resolution_func(&self) -> Option<usize>

The resolution function associated with this type.

fn as_subtype(&self) -> Option<&FloatingSubtype>

Returns Some if self is an FloatingSubtype, None otherwise.

fn is_universal(&self) -> bool

Checks whether this is a universal real type.

fn unwrap_basetype(&self) -> &FloatingBasetype

Returns an &FloatingBasetype or panics if the type is not a basetype.

fn unwrap_subtype(&self) -> &FloatingSubtype

Returns an &FloatingSubtype or panics if the type is not a subtype.

impl Eq for FloatingBasetype

impl Clone for FloatingBasetype

fn clone(&self) -> FloatingBasetype

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<FloatingBasetype> for FloatingBasetype

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

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

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

This method tests for !=.

impl Debug for FloatingBasetype

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

Formats the value using the given formatter.

impl Deref for FloatingBasetype

type Target = Range<f64>

The resulting type after dereferencing.

fn deref(&self) -> &Range<f64>

Dereferences the value.

impl Display for FloatingBasetype

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

Formats the value using the given formatter.