Struct Coordinate

pub struct Coordinate {
    pub portion: SmallVec<[f64; 8]>,
    pub error: f64,
    pub adjustment: f64,
    pub height: f64,
}

A specialized structure for holding network coordinates for the Vivaldi-based coordinate mapping algorithm. All of the fields should be public to enable this to be serialized. All values in here are in units of seconds.

Fields

portion: SmallVec<[f64; 8]>

The Euclidean portion of the coordinate. This is used along with the other fields to provide an overall distance estimate. The units here are seconds.

error: f64

Reflects the confidence in the given coordinate and is updated dynamically by the Vivaldi Client. This is dimensionless.

adjustment: f64

A distance offset computed based on a calculation over observations from all other nodes over a fixed window and is updated dynamically by the Vivaldi Client. The units here are seconds.

height: f64

A distance offset that accounts for non-Euclidean effects which model the access links from nodes to the core Internet. The access links are usually set by bandwidth and congestion, and the core links usually follow distance based on geography.

Implementations

impl Coordinate

pub const fn portion(&self) -> &SmallVec<[f64; 8]>

Returns the Euclidean portion of the coordinate.

pub const fn error(&self) -> f64

Returns the confidence in the given coordinate.

pub const fn adjustment(&self) -> f64

Returns the distance offset.

pub const fn height(&self) -> f64

Returns the distance offset that accounts for non-Euclidean effects.

pub fn with_portion(self, val: SmallVec<[f64; 8]>) -> Self

Sets the Euclidean portion of the coordinate.

pub fn with_error(self, val: f64) -> Self

Sets the confidence in the given coordinate.

pub fn with_adjustment(self, val: f64) -> Self

Sets the distance offset.

pub fn with_height(self, val: f64) -> Self

Sets the distance offset that accounts for non-Euclidean effects.

impl Coordinate

pub fn new() -> Self

Creates a new coordinate at the origin, using the default options to supply key initial values.

pub fn with_options(opts: CoordinateOptions) -> Self

Creates a new coordinate at the origin, using the given options to supply key initial values.

pub fn is_valid(&self) -> bool

Returns true if the coordinate is valid.

pub fn is_compatible_with(&self, other: &Self) -> bool

Returns true if the dimensions of the coordinates are compatible.

pub fn apply_force(&self, height_min: f64, force: f64, other: &Self) -> Self

Returns the result of applying the force from the direction of the other coordinate.

pub fn apply_force_in_place( &mut self, height_min: f64, force: f64, other: &Self, )

Apply the result of applying the force from the direction of the other coordinate to self.

pub fn distance_to(&self, other: &Self) -> Duration

Returns the distance between this coordinate and the other coordinate, including adjustments.

Trait Implementations

impl Clone for Coordinate

fn clone(&self) -> Coordinate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Coordinate

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

Formats the value using the given formatter.

impl Default for Coordinate

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Coordinate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Coordinate

fn eq(&self, other: &Coordinate) -> 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 Serialize for Coordinate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Transformable for Coordinate

type Error = CoordinateTransformError

The error type returned when encoding or decoding fails.

fn encode(&self, dst: &mut [u8]) -> Result<usize, Self::Error>

Encodes the value into the given buffer for transmission.

fn encoded_len(&self) -> usize

Returns the encoded length of the value. This is used to pre-allocate a buffer for encoding.

fn decode(src: &[u8]) -> Result<(usize, Self), Self::Error>

where Self: Sized,

Decodes the value from the given buffer received over the wire.

fn encode_to_vec(&self) -> Result<Vec<u8>, Self::Error>

Encodes the value into a vec for transmission.

fn encode_to_writer<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Encodes the value into the given writer for transmission.

fn encode_to_async_writer<W>( &self, writer: &mut W, ) -> impl Future<Output = Result<usize, Error>> + Send

where W: AsyncWrite + Send + Unpin,

Encodes the value into the given async writer for transmission.

fn decode_from_reader<R>(reader: &mut R) -> Result<(usize, Self), Error>

where R: Read, Self: Sized,

Decodes the value from the given reader received over the wire.

fn decode_from_async_reader<R>( reader: &mut R, ) -> impl Future<Output = Result<(usize, Self), Error>> + Send

where R: AsyncRead + Send + Unpin, Self: Sized,

Decodes the value from the given async reader received over the wire.

impl StructuralPartialEq for Coordinate