Package org.jacop.fz

Class Options

  • public class Options
extends java.lang.Object
    It parses the options provided to flatzinc parser/executable. It contains information about all options used for a given flatzinc file.
    Version:
    4.8

    • Constructor Summary

      Constructors 
      Constructor Description
      Options​(java.lang.String[] args)
      It constructs an Options object and parses all the parameters/options provided to flatzinc to jacop parser.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean complementarySearch()
      It defines wheter additional search should use output variables only (false, default).
      boolean debug()
      It defines whether to use debug information print-out.
      void doNotRunSearch()
      It defines whether to run the solver.
      boolean freeSearch()
      It defines whether search annotation can be ignored.
      boolean getAll()
      It returns true if the search for all solution has been requested.
      boolean getBoundConsistency()
      It defines whether to use bound consistency
      float getDecay()  
      java.io.FileInputStream getFile()
      It returns the file input stream for the file containing flatzinc description.
      java.lang.String getFileName()
      It returns the file name for the file containing flatzinc description.
      boolean getInterval()
      It returns true if the interval print mode has been requested.
      int getNumberSolutions()
      It returns the number of solutions the solver should search for.
      java.lang.String getOutputFilename()  
      double getPrecision()
      It returns precision defined in the command line
      boolean getStatistics()
      It returns true if the search statistics are to be displayed.
      int getTimeOut()
      It returns time out set for the search.
      boolean getVerbose()
      It returns true if the verbose mode has been requested.
      boolean precision()
      It informs whether precision is defined.
      boolean runSearch()
      It returns true if the search must be run and false otherwise.
      boolean useSat()
      It defines whether sat is used.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • file

        java.io.FileInputStream file

      • fileName

        java.lang.String fileName

      • all

        boolean all

      • verbose

        boolean verbose

      • statistics

        boolean statistics

      • freeSearch

        boolean freeSearch

      • time_out

        int time_out

      • number_solutions

        int number_solutions

      • interval

        boolean interval

      • precisionDefined

        boolean precisionDefined

      • precision

        double precision

      • format

        double format

      • boundConsistency

        boolean boundConsistency

      • runSearch

        boolean runSearch

      • use_sat

        boolean use_sat

      • complementary_search

        boolean complementary_search

      • decay

        float decay

      • step

        double step

      • debug

        boolean debug

      • outputFilename

        java.lang.String outputFilename

    • Constructor Detail

      • Options

        public Options​(java.lang.String[] args)
        It constructs an Options object and parses all the parameters/options provided to flatzinc to jacop parser.
        Parameters:
        args - arguments to flatzinc to jacop parser.

    • Method Detail

      • getFile

        public java.io.FileInputStream getFile()
        It returns the file input stream for the file containing flatzinc description.
        Returns:
        file containing flatzinc description.

      • getFileName

        public java.lang.String getFileName()
        It returns the file name for the file containing flatzinc description.
        Returns:
        file name containing flatzinc description.

      • getAll

        public boolean getAll()
        It returns true if the search for all solution has been requested.
        Returns:
        true if the search for all solution should take place, false otherwise.

      • getVerbose

        public boolean getVerbose()
        It returns true if the verbose mode has been requested.
        Returns:
        true if the verbose mode is active, false otherwise.

      • getStatistics

        public boolean getStatistics()
        It returns true if the search statistics are to be displayed.
        Returns:
        true if the search statistics are to be displayed, false otherwise.

      • getTimeOut

        public int getTimeOut()
        It returns time out set for the search.
        Returns:
        the value of the timeOut (in seconds), 0 if no time-out was set.

      • getNumberSolutions

        public int getNumberSolutions()
        It returns the number of solutions the solver should search for.
        Returns:
        the number of solutions the search should search for.

      • getInterval

        public boolean getInterval()
        It returns true if the interval print mode has been requested.
        Returns:
        true if the interval print mode is active, false otherwise.

      • doNotRunSearch

        public void doNotRunSearch()
        It defines whether to run the solver.

      • runSearch

        public boolean runSearch()
        It returns true if the search must be run and false otherwise.
        Returns:
        true if run search, false otherwise.

      • getBoundConsistency

        public boolean getBoundConsistency()
        It defines whether to use bound consistency
        Returns:
        true if bound consistency prefered, false otherwise (defult).

      • getPrecision

        public double getPrecision()
        It returns precision defined in the command line
        Returns:
        precision.

      • precision

        public boolean precision()
        It informs whether precision is defined.
        Returns:
        true if precision for floating point solver is defined

      • useSat

        public boolean useSat()
        It defines whether sat is used.
        Returns:
        true sat is used, false otherwise

      • debug

        public boolean debug()
        It defines whether to use debug information print-out.
        Returns:
        true if debugging information is printed, false otherwise

      • freeSearch

        public boolean freeSearch()
        It defines whether search annotation can be ignored.
        Returns:
        true if search annotation can be ignored

      • getOutputFilename

        public java.lang.String getOutputFilename()

      • getDecay

        public float getDecay()

      • complementarySearch

        public boolean complementarySearch()
        It defines wheter additional search should use output variables only (false, default). or should try to collect all non introduced variables (true).
        Returns:
        additional search should use output variables only (false, default). or should try to collect all non introduced variables (true)