Struct CliArgs

pub struct CliArgs {

    pub src: PathBuf,
    pub perm: Option<PathBuf>,
    pub work_dir: Option<PathBuf>,
    pub epserde: bool,
    pub gammas: Vec<String>,
    pub max_updates: usize,
    pub modified: bool,
    pub perc_modified: Option<f64>,
    pub gain_threshold: f64,
    pub improv_threshold: f64,
    pub num_threads: NumThreadsArg,
    pub seed: u64,
    pub granularity: GranularityArgs,
    pub chunk_size: Option<usize>,
}

Fields

src: PathBuf

The basename of the graph.

perm: Option<PathBuf>

A filename for the LLP permutation in binary big-endian format. If not provided, we will compute the labels but not combine them into the final permutation. If you don’t set this parameter, be sure to set work_dir so the labels will not be deleted at the end.

work_dir: Option<PathBuf>

The folder where the LLP labels are stored. If not specified, a temp dir will be used which will be deleted at the end of the computation. The temp dir parent folder can be specified with the TMPDIR environment variable. Setting a work_dir has two purposes: saving the information they compute and to be able to resume the computation of gammas as their computation on large graphs might take days. The labels represent information about communities in the graph, nodes similar will have the same label. To resume computation you can compute the remaining gammas without passing perm, and then finally run combine that will combine all the labels of the gammas present in the folder into a final permutation.

epserde: bool

Save the permutation in ε-serde format.

gammas: Vec<String>

The ɣ’s to use in LLP, separated by commas. The format is given by a integer numerator (if missing, assumed to be one), a dash, and then a power-of-two exponent for the denominator. For example, -2 is 1/4, and 0-0 is 0.

max_updates: usize

If specified, the maximum number of updates for a given ɣ.

modified: bool

If true, updates will be stopped when the number of modified nodes is less than the square root of the number of nodes of the graph.

perc_modified: Option<f64>

If true, updates will be stopped when the number of modified nodes is less than the specified percentage of the number of nodes of the graph.

gain_threshold: f64

The gain threshold used to stop the computation (0 to disable).

improv_threshold: f64

The threshold on the average (over the last ten updates) gain improvement used to stop the computation (-Inf to disable).

num_threads: NumThreadsArg

seed: u64

The seed to use for the PRNG.

granularity: GranularityArgs

chunk_size: Option<usize>

The chunk size used to localize the random permutation (advanced option).

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.