Scippy

SCIP

Solving Constraint Integer Programs

polyscip::CmdLineArgs Class Reference

Detailed Description

Command line arguments for PolySCIP.

Definition at line 34 of file cmd_line_args.h.

Command line arguments for PolySCIP. More...

#include <cmd_line_args.h>

Public Types

using TimeLimitType = long
 Value type used for cmd line parameter -t | - - timeLimit. More...
 

Public Member Functions

 CmdLineArgs (int argc, const char *const *argv)
 
bool beVerbose () const
 
bool onlyExtremal () const
 
bool writeResults () const
 
bool outputOutcomes () const
 
bool outputSols () const
 
bool hasTimeLimit () const
 
bool hasParameterFile () const
 
int roundWeightedObjCoeff () const
 
TimeLimitType getTimeLimit () const
 
double getDelta () const
 
double getEpsilon () const
 
std::string getParameterFile () const
 
std::string getProblemFile () const
 
std::string getWritePath () const
 

Static Public Attributes

static constexpr auto kTimeLimitInf = std::numeric_limits<TimeLimitType>::max()
 Constant used for default value of cmd line parameter -t | - - timeLimit. More...
 

Member Typedef Documentation

◆ TimeLimitType

Value type used for cmd line parameter -t | - - timeLimit.

Definition at line 37 of file cmd_line_args.h.

Constructor & Destructor Documentation

◆ CmdLineArgs()

polyscip::CmdLineArgs::CmdLineArgs ( int  argc,
const char *const *  argv 
)

Constructor

Parameters
argcArgument count
argvArgument vector

Definition at line 44 of file cmd_line_args.cpp.

References kTimeLimitInf, POLYSCIP_VERSION_MAJOR, and POLYSCIP_VERSION_MINOR.

Member Function Documentation

◆ beVerbose()

bool polyscip::CmdLineArgs::beVerbose ( ) const
inline

For cmd line parameter -v | - -verbose

Returns
true if -v was set on cmd line

Definition at line 53 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::computeNondomPoints(), polyscip::Polyscip::numberofUnboundedResults(), and polyscip::Polyscip::readProblem().

◆ onlyExtremal()

bool polyscip::CmdLineArgs::onlyExtremal ( ) const
inline

For cmd line parameter -x | - -extremal

Returns
true if -x was set on cmd line

Definition at line 59 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::readProblem().

◆ writeResults()

bool polyscip::CmdLineArgs::writeResults ( ) const
inline

For cmd line parameter -w | - -writeResults

Returns
true if -w was set on cmd line

Definition at line 65 of file cmd_line_args.h.

◆ outputOutcomes()

bool polyscip::CmdLineArgs::outputOutcomes ( ) const
inline

For cmd line parameter -o | - -noOutcomes

Returns
false if -o was set on cmd line

Definition at line 71 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::printResults().

◆ outputSols()

bool polyscip::CmdLineArgs::outputSols ( ) const
inline

For cmd line parameter -s | - -noSolutions

Returns
false if -s was set on cmd line

Definition at line 77 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::printResults().

◆ hasTimeLimit()

bool polyscip::CmdLineArgs::hasTimeLimit ( ) const
inline

For cmd line parameter -t | - -timeLimit

Returns
true if -t "<seconds>" was set on cmd line

Definition at line 83 of file cmd_line_args.h.

References kTimeLimitInf.

Referenced by polyscip::Polyscip::numberofUnboundedResults(), and polyscip::Polyscip::Polyscip().

◆ hasParameterFile()

bool polyscip::CmdLineArgs::hasParameterFile ( ) const
inline

For cmd line parameter -p | - -params

Returns
true if -p <paramFile.set> was set on cmd line

Definition at line 89 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::Polyscip().

◆ roundWeightedObjCoeff()

int polyscip::CmdLineArgs::roundWeightedObjCoeff ( ) const
inline

For cmd line parameter -r | - -round

Returns
corresponding integer if -r <5|10|15> was set on cmd line

Definition at line 95 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::numberofUnboundedResults().

◆ getTimeLimit()

TimeLimitType polyscip::CmdLineArgs::getTimeLimit ( ) const
inline

For cmd line parameter -t | - -timeLimit

Returns
corresponding seconds given for parameter -t "<seconds>"

Definition at line 101 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::numberofUnboundedResults(), and polyscip::Polyscip::Polyscip().

◆ getDelta()

double polyscip::CmdLineArgs::getDelta ( ) const
inline

For cmd line parameter -d | - -delta

Returns
corresponding double value given for -d "<double>"

Definition at line 107 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::computeNondomPoints(), and polyscip::Polyscip::Polyscip().

◆ getEpsilon()

double polyscip::CmdLineArgs::getEpsilon ( ) const
inline

For cmd line parameter -e | - -epsilon

Returns
corresponding double value given for -e "<double>"

Definition at line 113 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::computeNondomPoints(), polyscip::Polyscip::numberofUnboundedResults(), and polyscip::Polyscip::Polyscip().

◆ getParameterFile()

std::string polyscip::CmdLineArgs::getParameterFile ( ) const
inline

For cmd line parameter -p | - -params

Returns
corresponding parameter file given for -p "<paramFile.set>"

Definition at line 119 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::Polyscip().

◆ getProblemFile()

std::string polyscip::CmdLineArgs::getProblemFile ( ) const
inline

For cmd line argument problemFile.mop

Returns
corresponding problem file given for "<problemFile.mop>" on cmd line

Definition at line 125 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::Polyscip(), polyscip::Polyscip::readProblem(), and polyscip::Polyscip::writeResultsToFile().

◆ getWritePath()

std::string polyscip::CmdLineArgs::getWritePath ( ) const
inline

For cmd line parameter -W | - -writeSolsPath

Returns
corresponding path given -W "<PATH>"

Definition at line 131 of file cmd_line_args.h.

Referenced by polyscip::Polyscip::writeResultsToFile().

Field Documentation

◆ kTimeLimitInf

constexpr auto polyscip::CmdLineArgs::kTimeLimitInf = std::numeric_limits<TimeLimitType>::max()
static

Constant used for default value of cmd line parameter -t | - - timeLimit.

Definition at line 40 of file cmd_line_args.h.

Referenced by CmdLineArgs(), and hasTimeLimit().