/******************************************************************************

 * Top contributors (to current version):

 *   Mathias Preiner, Aina Niemetz

 *

 * This file is part of the cvc5 project.

 *

 * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS

 * in the top-level source directory and their institutional affiliations.

 * All rights reserved.  See the file COPYING in the top-level source

 * directory for licensing information.

 * ****************************************************************************

 *

 * Contains code for handling command-line options.

 *

 * For each <module>_options.toml configuration file, mkoptions.py

 * expands this template and generates a <module>_options.h file.

 */

#include "cvc5_private.h"

#ifndef CVC5__OPTIONS__ARITH_H

#define CVC5__OPTIONS__ARITH_H

#include "options/options.h"

// clang-format off

// clang-format on

namespace cvc5::options {

// clang-format off

enum class ArithPropagationMode

{

  BOUND_INFERENCE_PROP, NO_PROP, BOTH_PROP, UNATE_PROP

};

static constexpr size_t ArithPropagationMode__numValues = 4;

std::ostream& operator<<(std::ostream& os, ArithPropagationMode mode);

ArithPropagationMode stringToArithPropagationMode(const std::string& optarg);

enum class ErrorSelectionRule

{

  SUM_METRIC, MAXIMUM_AMOUNT, VAR_ORDER, MINIMUM_AMOUNT

};

static constexpr size_t ErrorSelectionRule__numValues = 4;

std::ostream& operator<<(std::ostream& os, ErrorSelectionRule mode);

ErrorSelectionRule stringToErrorSelectionRule(const std::string& optarg);

enum class NlCadLiftingMode

{

  LAZARD, REGULAR

};

static constexpr size_t NlCadLiftingMode__numValues = 2;

std::ostream& operator<<(std::ostream& os, NlCadLiftingMode mode);

NlCadLiftingMode stringToNlCadLiftingMode(const std::string& optarg);

enum class NlCadProjectionMode

{

  LAZARD, LAZARDMOD, MCCALLUM

};

static constexpr size_t NlCadProjectionMode__numValues = 3;

std::ostream& operator<<(std::ostream& os, NlCadProjectionMode mode);

NlCadProjectionMode stringToNlCadProjectionMode(const std::string& optarg);

enum class NlExtMode

{

  FULL, LIGHT, NONE

};

static constexpr size_t NlExtMode__numValues = 3;

std::ostream& operator<<(std::ostream& os, NlExtMode mode);

NlExtMode stringToNlExtMode(const std::string& optarg);

enum class NlRlvMode

{

  INTERLEAVE, ALWAYS, NONE

};

static constexpr size_t NlRlvMode__numValues = 3;

std::ostream& operator<<(std::ostream& os, NlRlvMode mode);

NlRlvMode stringToNlRlvMode(const std::string& optarg);

enum class ArithUnateLemmaMode

{

  NO, INEQUALITY, EQUALITY, ALL

};

static constexpr size_t ArithUnateLemmaMode__numValues = 4;

std::ostream& operator<<(std::ostream& os, ArithUnateLemmaMode mode);

ArithUnateLemmaMode stringToArithUnateLemmaMode(const std::string& optarg);

// clang-format on

#if defined(CVC5_MUZZLED) || defined(CVC5_COMPETITION_MODE)

#  define DO_SEMANTIC_CHECKS_BY_DEFAULT false

#else /* CVC5_MUZZLED || CVC5_COMPETITION_MODE */

#  define DO_SEMANTIC_CHECKS_BY_DEFAULT true

#endif /* CVC5_MUZZLED || CVC5_COMPETITION_MODE */

{

// clang-format off

int64_t maxApproxDepth = 200;

  bool maxApproxDepthWasSetByUser = false;

  bool brabTest = true;

  bool brabTestWasSetByUser = false;

  bool arithCongMan = true;

  bool arithCongManWasSetByUser = false;

  bool arithEqSolver = false;

  bool arithEqSolverWasSetByUser = false;

  bool arithNoPartialFun = false;

  bool arithNoPartialFunWasSetByUser = false;

  ArithPropagationMode arithPropagationMode = ArithPropagationMode::BOTH_PROP;

  bool arithPropagationModeWasSetByUser = false;

  uint64_t arithPropAsLemmaLength = 8;

  bool arithPropAsLemmaLengthWasSetByUser = false;

  bool arithRewriteEq = false;

  bool arithRewriteEqWasSetByUser = false;

  bool collectPivots = false;

  bool collectPivotsWasSetByUser = false;

  bool doCutAllBounded = false;

  bool doCutAllBoundedWasSetByUser = false;

  bool exportDioDecompositions = false;

  bool exportDioDecompositionsWasSetByUser = false;

  bool arithDioSolver = true;

  bool arithDioSolverWasSetByUser = false;

  int64_t dioSolverTurns = 10;

  bool dioSolverTurnsWasSetByUser = false;

  ErrorSelectionRule arithErrorSelectionRule = ErrorSelectionRule::MINIMUM_AMOUNT;

  bool arithErrorSelectionRuleWasSetByUser = false;

  bool havePenalties = false;

  bool havePenaltiesWasSetByUser = false;

  int64_t arithHeuristicPivots = 0;

  bool arithHeuristicPivotsWasSetByUser = false;

  bool replayFailureLemma = false;

  bool replayFailureLemmaWasSetByUser = false;

  uint64_t maxCutsInContext = 65535;

  bool maxCutsInContextWasSetByUser = false;

  bool arithMLTrick = false;

  bool arithMLTrickWasSetByUser = false;

  uint64_t arithMLTrickSubstitutions = 1;

  bool arithMLTrickSubstitutionsWasSetByUser = false;

  bool newProp = true;

  bool newPropWasSetByUser = false;

  bool nlCad = false;

  bool nlCadWasSetByUser = false;

  bool nlCadUseInitial = false;

  bool nlCadUseInitialWasSetByUser = false;

  NlCadLiftingMode nlCadLifting = NlCadLiftingMode::REGULAR;

  bool nlCadLiftingWasSetByUser = false;

  NlCadProjectionMode nlCadProjection = NlCadProjectionMode::MCCALLUM;

  bool nlCadProjectionWasSetByUser = false;

  NlExtMode nlExt = NlExtMode::FULL;

  bool nlExtWasSetByUser = false;

  bool nlExtEntailConflicts = false;

  bool nlExtEntailConflictsWasSetByUser = false;

  bool nlExtFactor = true;

  bool nlExtFactorWasSetByUser = false;

  bool nlExtIncPrecision = true;

  bool nlExtIncPrecisionWasSetByUser = false;

  bool nlExtPurify = false;

  bool nlExtPurifyWasSetByUser = false;

  bool nlExtResBound = false;

  bool nlExtResBoundWasSetByUser = false;

  bool nlExtRewrites = true;

  bool nlExtRewritesWasSetByUser = false;

  bool nlExtSplitZero = false;

  bool nlExtSplitZeroWasSetByUser = false;

  int64_t nlExtTfTaylorDegree = 4;

  bool nlExtTfTaylorDegreeWasSetByUser = false;

  bool nlExtTfTangentPlanes = true;

  bool nlExtTfTangentPlanesWasSetByUser = false;

  bool nlExtTangentPlanes = false;

  bool nlExtTangentPlanesWasSetByUser = false;

  bool nlExtTangentPlanesInterleave = false;

  bool nlExtTangentPlanesInterleaveWasSetByUser = false;

  bool nlICP = false;

  bool nlICPWasSetByUser = false;

  NlRlvMode nlRlvMode = NlRlvMode::NONE;

  bool nlRlvModeWasSetByUser = false;

  bool nlRlvAssertBounds = false;

  bool nlRlvAssertBoundsWasSetByUser = false;

  bool pbRewrites = false;

  bool pbRewritesWasSetByUser = false;

  uint64_t arithPivotThreshold = 2;

  bool arithPivotThresholdWasSetByUser = false;

  uint64_t ppAssertMaxSubSize = 2;

  bool ppAssertMaxSubSizeWasSetByUser = false;

  uint64_t arithPropagateMaxLength = 16;

  bool arithPropagateMaxLengthWasSetByUser = false;

  int64_t replayEarlyCloseDepths = 1;

  bool replayEarlyCloseDepthsWasSetByUser = false;

  uint64_t lemmaRejectCutSize = 25500;

  bool lemmaRejectCutSizeWasSetByUser = false;

  int64_t replayNumericFailurePenalty = 4194304;

  bool replayNumericFailurePenaltyWasSetByUser = false;

  uint64_t replayRejectCutSize = 25500;

  bool replayRejectCutSizeWasSetByUser = false;

  bool restrictedPivots = true;

  bool restrictedPivotsWasSetByUser = false;

  bool revertArithModels = false;

  bool revertArithModelsWasSetByUser = false;

  int64_t rrTurns = 3;

  bool rrTurnsWasSetByUser = false;

  bool trySolveIntStandardEffort = false;

  bool trySolveIntStandardEffortWasSetByUser = false;

  uint64_t arithSimplexCheckPeriod = 200;

  bool arithSimplexCheckPeriodWasSetByUser = false;

  bool soiQuickExplain = false;

  bool soiQuickExplainWasSetByUser = false;

  int64_t arithStandardCheckVarOrderPivots = -1;

  bool arithStandardCheckVarOrderPivotsWasSetByUser = false;

  ArithUnateLemmaMode arithUnateLemmaMode = ArithUnateLemmaMode::ALL;

  bool arithUnateLemmaModeWasSetByUser = false;

  bool useApprox = false;

  bool useApproxWasSetByUser = false;

  bool useFC = false;

  bool useFCWasSetByUser = false;

  bool useSOI = false;

  bool useSOIWasSetByUser = false;

// clang-format on

};

#undef DO_SEMANTIC_CHECKS_BY_DEFAULT

// clang-format off

inline int64_t maxApproxDepth() { return Options::current().arith.maxApproxDepth; }

inline bool brabTest() { return Options::current().arith.brabTest; }

inline bool arithCongMan() { return Options::current().arith.arithCongMan; }

inline ArithPropagationMode arithPropagationMode() { return Options::current().arith.arithPropagationMode; }

inline uint64_t arithPropAsLemmaLength() { return Options::current().arith.arithPropAsLemmaLength; }

inline bool collectPivots() { return Options::current().arith.collectPivots; }

inline bool doCutAllBounded() { return Options::current().arith.doCutAllBounded; }

inline bool arithDioSolver() { return Options::current().arith.arithDioSolver; }

inline int64_t dioSolverTurns() { return Options::current().arith.dioSolverTurns; }

inline bool replayFailureLemma() { return Options::current().arith.replayFailureLemma; }

inline uint64_t maxCutsInContext() { return Options::current().arith.maxCutsInContext; }

inline uint64_t arithMLTrickSubstitutions() { return Options::current().arith.arithMLTrickSubstitutions; }

inline bool newProp() { return Options::current().arith.newProp; }

inline bool nlCad() { return Options::current().arith.nlCad; }

inline bool nlCadUseInitial() { return Options::current().arith.nlCadUseInitial; }

inline NlCadLiftingMode nlCadLifting() { return Options::current().arith.nlCadLifting; }

inline NlCadProjectionMode nlCadProjection() { return Options::current().arith.nlCadProjection; }

inline NlExtMode nlExt() { return Options::current().arith.nlExt; }

inline bool nlExtEntailConflicts() { return Options::current().arith.nlExtEntailConflicts; }

inline bool nlExtFactor() { return Options::current().arith.nlExtFactor; }

inline bool nlExtIncPrecision() { return Options::current().arith.nlExtIncPrecision; }

inline bool nlExtResBound() { return Options::current().arith.nlExtResBound; }

inline bool nlExtRewrites() { return Options::current().arith.nlExtRewrites; }

inline bool nlExtSplitZero() { return Options::current().arith.nlExtSplitZero; }

inline int64_t nlExtTfTaylorDegree() { return Options::current().arith.nlExtTfTaylorDegree; }

inline bool nlExtTfTangentPlanes() { return Options::current().arith.nlExtTfTangentPlanes; }

inline bool nlExtTangentPlanes() { return Options::current().arith.nlExtTangentPlanes; }

inline bool nlExtTangentPlanesInterleave() { return Options::current().arith.nlExtTangentPlanesInterleave; }

inline bool nlICP() { return Options::current().arith.nlICP; }

inline NlRlvMode nlRlvMode() { return Options::current().arith.nlRlvMode; }

inline bool nlRlvAssertBounds() { return Options::current().arith.nlRlvAssertBounds; }

inline uint64_t ppAssertMaxSubSize() { return Options::current().arith.ppAssertMaxSubSize; }

inline uint64_t arithPropagateMaxLength() { return Options::current().arith.arithPropagateMaxLength; }

inline int64_t replayEarlyCloseDepths() { return Options::current().arith.replayEarlyCloseDepths; }

inline uint64_t lemmaRejectCutSize() { return Options::current().arith.lemmaRejectCutSize; }

inline int64_t replayNumericFailurePenalty() { return Options::current().arith.replayNumericFailurePenalty; }

inline uint64_t replayRejectCutSize() { return Options::current().arith.replayRejectCutSize; }

inline bool restrictedPivots() { return Options::current().arith.restrictedPivots; }

inline bool revertArithModels() { return Options::current().arith.revertArithModels; }

inline int64_t rrTurns() { return Options::current().arith.rrTurns; }

inline bool trySolveIntStandardEffort() { return Options::current().arith.trySolveIntStandardEffort; }

inline int64_t arithStandardCheckVarOrderPivots() { return Options::current().arith.arithStandardCheckVarOrderPivots; }

inline ArithUnateLemmaMode arithUnateLemmaMode() { return Options::current().arith.arithUnateLemmaMode; }

inline bool useApprox() { return Options::current().arith.useApprox; }

inline bool useFC() { return Options::current().arith.useFC; }

inline bool useSOI() { return Options::current().arith.useSOI; }

// clang-format on

namespace arith

{

// clang-format off

static constexpr const char* maxApproxDepth__name = "approx-branch-depth";

static constexpr const char* brabTest__name = "arith-brab";

static constexpr const char* arithCongMan__name = "arith-cong-man";

static constexpr const char* arithEqSolver__name = "arith-eq-solver";

static constexpr const char* arithNoPartialFun__name = "arith-no-partial-fun";

static constexpr const char* arithPropagationMode__name = "arith-prop";

static constexpr const char* arithPropAsLemmaLength__name = "arith-prop-clauses";

static constexpr const char* arithRewriteEq__name = "arith-rewrite-equalities";

static constexpr const char* collectPivots__name = "collect-pivot-stats";

static constexpr const char* doCutAllBounded__name = "cut-all-bounded";

static constexpr const char* exportDioDecompositions__name = "dio-decomps";

static constexpr const char* arithDioSolver__name = "dio-solver";

static constexpr const char* dioSolverTurns__name = "dio-turns";

static constexpr const char* arithErrorSelectionRule__name = "error-selection-rule";

static constexpr const char* havePenalties__name = "fc-penalties";

static constexpr const char* arithHeuristicPivots__name = "heuristic-pivots";

static constexpr const char* replayFailureLemma__name = "lemmas-on-replay-failure";

static constexpr const char* maxCutsInContext__name = "maxCutsInContext";

static constexpr const char* arithMLTrick__name = "miplib-trick";

static constexpr const char* arithMLTrickSubstitutions__name = "miplib-trick-subs";

static constexpr const char* newProp__name = "new-prop";

static constexpr const char* nlCad__name = "nl-cad";

static constexpr const char* nlCadUseInitial__name = "nl-cad-initial";

static constexpr const char* nlCadLifting__name = "nl-cad-lift";

static constexpr const char* nlCadProjection__name = "nl-cad-proj";

static constexpr const char* nlExt__name = "nl-ext";

static constexpr const char* nlExtEntailConflicts__name = "nl-ext-ent-conf";

static constexpr const char* nlExtFactor__name = "nl-ext-factor";

static constexpr const char* nlExtIncPrecision__name = "nl-ext-inc-prec";

static constexpr const char* nlExtPurify__name = "nl-ext-purify";

static constexpr const char* nlExtResBound__name = "nl-ext-rbound";

static constexpr const char* nlExtRewrites__name = "nl-ext-rewrite";

static constexpr const char* nlExtSplitZero__name = "nl-ext-split-zero";

static constexpr const char* nlExtTfTaylorDegree__name = "nl-ext-tf-taylor-deg";

static constexpr const char* nlExtTfTangentPlanes__name = "nl-ext-tf-tplanes";

static constexpr const char* nlExtTangentPlanes__name = "nl-ext-tplanes";

static constexpr const char* nlExtTangentPlanesInterleave__name = "nl-ext-tplanes-interleave";

static constexpr const char* nlICP__name = "nl-icp";

static constexpr const char* nlRlvMode__name = "nl-rlv";

static constexpr const char* nlRlvAssertBounds__name = "nl-rlv-assert-bounds";

static constexpr const char* pbRewrites__name = "pb-rewrites";

static constexpr const char* arithPivotThreshold__name = "pivot-threshold";

static constexpr const char* ppAssertMaxSubSize__name = "pp-assert-max-sub-size";

static constexpr const char* arithPropagateMaxLength__name = "prop-row-length";

static constexpr const char* replayEarlyCloseDepths__name = "replay-early-close-depth";

static constexpr const char* lemmaRejectCutSize__name = "replay-lemma-reject-cut";

static constexpr const char* replayNumericFailurePenalty__name = "replay-num-err-penalty";

static constexpr const char* replayRejectCutSize__name = "replay-reject-cut";

static constexpr const char* restrictedPivots__name = "restrict-pivots";

static constexpr const char* revertArithModels__name = "revert-arith-models-on-unsat";

static constexpr const char* rrTurns__name = "rr-turns";

static constexpr const char* trySolveIntStandardEffort__name = "se-solve-int";

static constexpr const char* arithSimplexCheckPeriod__name = "simplex-check-period";

static constexpr const char* soiQuickExplain__name = "soi-qe";

static constexpr const char* arithStandardCheckVarOrderPivots__name = "standard-effort-variable-order-pivots";

static constexpr const char* arithUnateLemmaMode__name = "unate-lemmas";

static constexpr const char* useApprox__name = "use-approx";

static constexpr const char* useFC__name = "use-fcsimplex";

static constexpr const char* useSOI__name = "use-soi";

void setDefaultMaxApproxDepth(Options& opts, int64_t value);

void setDefaultBrabTest(Options& opts, bool value);

void setDefaultArithCongMan(Options& opts, bool value);

void setDefaultArithEqSolver(Options& opts, bool value);

void setDefaultArithNoPartialFun(Options& opts, bool value);

void setDefaultArithPropagationMode(Options& opts, ArithPropagationMode value);

void setDefaultArithPropAsLemmaLength(Options& opts, uint64_t value);

void setDefaultArithRewriteEq(Options& opts, bool value);

void setDefaultCollectPivots(Options& opts, bool value);

void setDefaultDoCutAllBounded(Options& opts, bool value);

void setDefaultExportDioDecompositions(Options& opts, bool value);

void setDefaultArithDioSolver(Options& opts, bool value);

void setDefaultDioSolverTurns(Options& opts, int64_t value);

void setDefaultArithErrorSelectionRule(Options& opts, ErrorSelectionRule value);

void setDefaultHavePenalties(Options& opts, bool value);

void setDefaultArithHeuristicPivots(Options& opts, int64_t value);

void setDefaultReplayFailureLemma(Options& opts, bool value);

void setDefaultMaxCutsInContext(Options& opts, uint64_t value);

void setDefaultArithMLTrick(Options& opts, bool value);

void setDefaultArithMLTrickSubstitutions(Options& opts, uint64_t value);

void setDefaultNewProp(Options& opts, bool value);

void setDefaultNlCad(Options& opts, bool value);

void setDefaultNlCadUseInitial(Options& opts, bool value);

void setDefaultNlCadLifting(Options& opts, NlCadLiftingMode value);

void setDefaultNlCadProjection(Options& opts, NlCadProjectionMode value);

void setDefaultNlExt(Options& opts, NlExtMode value);

void setDefaultNlExtEntailConflicts(Options& opts, bool value);

void setDefaultNlExtFactor(Options& opts, bool value);

void setDefaultNlExtIncPrecision(Options& opts, bool value);

void setDefaultNlExtPurify(Options& opts, bool value);

void setDefaultNlExtResBound(Options& opts, bool value);

void setDefaultNlExtRewrites(Options& opts, bool value);

void setDefaultNlExtSplitZero(Options& opts, bool value);

void setDefaultNlExtTfTaylorDegree(Options& opts, int64_t value);

void setDefaultNlExtTfTangentPlanes(Options& opts, bool value);

void setDefaultNlExtTangentPlanes(Options& opts, bool value);

void setDefaultNlExtTangentPlanesInterleave(Options& opts, bool value);

void setDefaultNlICP(Options& opts, bool value);

void setDefaultNlRlvMode(Options& opts, NlRlvMode value);

void setDefaultNlRlvAssertBounds(Options& opts, bool value);

void setDefaultPbRewrites(Options& opts, bool value);

void setDefaultArithPivotThreshold(Options& opts, uint64_t value);

void setDefaultPpAssertMaxSubSize(Options& opts, uint64_t value);

void setDefaultArithPropagateMaxLength(Options& opts, uint64_t value);

void setDefaultReplayEarlyCloseDepths(Options& opts, int64_t value);

void setDefaultLemmaRejectCutSize(Options& opts, uint64_t value);

void setDefaultReplayNumericFailurePenalty(Options& opts, int64_t value);

void setDefaultReplayRejectCutSize(Options& opts, uint64_t value);

void setDefaultRestrictedPivots(Options& opts, bool value);

void setDefaultRevertArithModels(Options& opts, bool value);

void setDefaultRrTurns(Options& opts, int64_t value);

void setDefaultTrySolveIntStandardEffort(Options& opts, bool value);

void setDefaultArithSimplexCheckPeriod(Options& opts, uint64_t value);

void setDefaultSoiQuickExplain(Options& opts, bool value);

void setDefaultArithStandardCheckVarOrderPivots(Options& opts, int64_t value);

void setDefaultArithUnateLemmaMode(Options& opts, ArithUnateLemmaMode value);

void setDefaultUseApprox(Options& opts, bool value);

void setDefaultUseFC(Options& opts, bool value);

void setDefaultUseSOI(Options& opts, bool value);

// clang-format on

}

}  // namespace cvc5::options

#endif /* CVC5__OPTIONS__ARITH_H */