Struct CliArgs

pub struct CliArgs {
    pub basename: PathBuf,
    pub symm: bool,
    pub transposed: Option<PathBuf>,
    pub neighborhood_function: bool,
    pub centralities: Centralities,
    pub log2m: usize,
    pub upper_bound: usize,
    pub threshold: Option<f64>,
    pub num_threads: NumThreadsArg,
    pub granularity: GranularityArgs,
    pub seed: u64,
}

Fields

basename: PathBuf

The basename of the graph.

symm: bool

Whether the graph is symmetric or not. If true, the algorithm will use the graph as its transposed.

transposed: Option<PathBuf>

The basename of the transposed graph. If available, HyperBall will perform systolic iterations which will speed up the computation. If the graph is symmetric, use the –symm option instead.

neighborhood_function: bool

Compute the approximate neighborhood function, which will be store in ASCII format as BASENAME.nf.

centralities: Centralities

log2m: usize

The base-2 logarithm of the number of registers for the HyperLogLog cardinality estimators.

upper_bound: usize

Maximum number of iterations to run.

threshold: Option<f64>

A value that will be used to stop the computation by relative increment if the neighborhood function is being computed. Otherwise, the computation will stop all estimators do not change their values.

num_threads: NumThreadsArg

granularity: GranularityArgs

seed: u64

The seed of the pseudorandom number generator used for initialization.

Trait Implementations

impl Args for CliArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for CliArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for CliArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CliArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CliArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.