Skip to main content

NcolLglOptions

Struct NcolLglOptions 

Source
pub struct NcolLglOptions {
    pub names: bool,
    pub weights: AddWeights,
    pub directed: bool,
}
Expand description

Options of the NCOL and LGL readers (Graph::read_graph_ncol, Graph::read_graph_lgl).

The defaults are: store names, add weights only if present in the file, undirected graph (the LGL software only handles undirected graphs).

names and weights only matter once the attribute handler is enabled with attributes::enable (see the module docs); without it they are harmless.

§Examples

use igraph::{foreign::NcolLglOptions, prelude::*};
let opts = NcolLglOptions::default().with_directed(true).with_weights(AddWeights::No);
assert!(opts.names && opts.directed);
let g = Graph::read_graph_ncol_from_str("a b 2\nb c 3\n", &[], &opts).unwrap();
assert!(g.is_directed());
assert_eq!(g.edge_list(), vec![(0, 1), (1, 2)]);

Fields§

§names: bool

Whether to store the symbolic vertex names as the name string vertex attribute.

§weights: AddWeights

Whether to store the edge weights as the weight numeric edge attribute: AddWeights::Yes always (edges without a weight get 1), AddWeights::IfPresent only if at least one weight is given in the file (again with 1 for the others), AddWeights::No never.

§directed: bool

Whether to create a directed graph: the formats carry no information about directedness.

Implementations§

Source§

impl NcolLglOptions

Source

pub fn with_directed(self, directed: bool) -> Self

Sets directed.

Source

pub fn with_names(self, names: bool) -> Self

Sets names.

Source

pub fn with_weights(self, weights: AddWeights) -> Self

Sets weights.

Trait Implementations§

Source§

impl Clone for NcolLglOptions

Source§

fn clone(&self) -> NcolLglOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for NcolLglOptions

Source§

impl Debug for NcolLglOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for NcolLglOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for NcolLglOptions

Source§

impl PartialEq for NcolLglOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for NcolLglOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.