Trait moc::qty::MocableQty

pub trait MocableQty: 'static + PartialEq + Eq + Send + Sync + Clone + Debug {
    const NAME: &'static str;
    const PREFIX: char;
    const DIM: u8;
    const N_D0_CELLS: u8;
    const MOC_DIM: MocDim;
    const HAS_COOSYS: bool;
    const HAS_TIMESYS: bool;
    const HAS_FREQSYS: bool;
    const N_RESERVED_BITS: u8 = 2u8;
    const N_D0_BITS: u8 = _;
    const LEVEL_MASK: u8 = _;

    // Required methods
    fn mult_by_dim<T: Idx>(v: T) -> T;
    fn div_by_dim<T: Idx>(v: T) -> T;

    // Provided method
    fn shift(delta_depth: u8) -> u8 { ... }
}

Generic constants defining a quantity that can be put in a MOC, independently of it the precise integer type used to represent it.

Required Associated Constants

const NAME: &'static str

A simple str to identify the quantity (e.g. in ASCII serialisation)

const PREFIX: char

A simple char prefix to identify the quantity (e.g. in ASCII serialisation)

const DIM: u8

Dimension of the qty, i.e. number of bits needed to code a sub-cell relative index

const N_D0_CELLS: u8

Number of base cells, i.e. number of cell at depth 0 (usually 2^dim, but 12 in the HEALPix case)

const MOC_DIM: MocDim

FITS keyword

const HAS_COOSYS: bool

For FITS serialization (TODO: find a better approach)

const HAS_TIMESYS: bool

For FITS serialization (TODO: find a better approach)

const HAS_FREQSYS: bool

For FITS serialization (TODO: find a better approach)

Provided Associated Constants

const N_RESERVED_BITS: u8 = 2u8

Number of bits reserved to code the quantity type

const N_D0_BITS: u8 = _

Number of bits needed to code the base cell index

const LEVEL_MASK: u8 = _

Mask to select the bit(s) of a level > 0:

• dim 1: 001
• dim 2: 011
• dim 3: 111

Required Methods

fn mult_by_dim<T: Idx>(v: T) -> T

v * Self::DIM, generic so that for:

• DIM=1 this is a no operation,
• DIM=2 we can use v << 1

fn div_by_dim<T: Idx>(v: T) -> T

v / Self::DIM, generic so that for:

• DIM=1 this is a no operation,
• DIM=2 we can use v >> 1

Provided Methods

fn shift(delta_depth: u8) -> u8

Object Safety

This trait is not object safe.

Implementors

impl<T: Idx> MocableQty for Frequency<T>

const N_RESERVED_BITS: u8 = 4u8

const NAME: &'static str = "FREQUENCY"

const PREFIX: char = 'f'

const DIM: u8 = 1u8

const N_D0_CELLS: u8 = 2u8

const MOC_DIM: MocDim = MocDim::Frequency

const HAS_COOSYS: bool = false

const HAS_TIMESYS: bool = false

const HAS_FREQSYS: bool = true

impl<T: Idx> MocableQty for Hpx<T>

const NAME: &'static str = "HPX"

const PREFIX: char = 's'

const DIM: u8 = 2u8

const N_D0_CELLS: u8 = 12u8

const MOC_DIM: MocDim = MocDim::Space

const HAS_COOSYS: bool = true

const HAS_TIMESYS: bool = false

const HAS_FREQSYS: bool = false

impl<T: Idx> MocableQty for Time<T>

const NAME: &'static str = "TIME"

const PREFIX: char = 't'

const DIM: u8 = 1u8

const N_D0_CELLS: u8 = 2u8

const MOC_DIM: MocDim = MocDim::Time

const HAS_COOSYS: bool = false

const HAS_TIMESYS: bool = true

const HAS_FREQSYS: bool = false