summaryrefslogtreecommitdiff
path: root/src/omt/omt_optimizer.h
blob: 1e4c6d4cab87d394ca384c17b772e9c996413f1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/******************************************************************************
 * Top contributors (to current version):
 *   Yancheng Ou
 *
 * 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.
 * ****************************************************************************
 *
 * The base class for optimizers of individual cvc5 type.
 */

#ifndef CVC5__OMT__OMT_OPTIMIZER_H
#define CVC5__OMT__OMT_OPTIMIZER_H

#include "smt/optimization_solver.h"

namespace cvc5::omt {

/**
 * The base class for optimizers of individual CVC type
 */
class OMTOptimizer
{
 public:
  virtual ~OMTOptimizer() = default;
  /**
   * Given a target node, retrieve an optimizer specific for the node's type
   * the second field isSigned specifies whether we should use signed comparison
   * for BitVectors and it's only valid when the type is BitVector
   *
   * @param targetNode the target node for the expression to be optimized
   * @param isSigned speficies whether to use signed comparison for BitVectors
   *   and it's only valid when the type of targetNode is BitVector
   * @return a unique_pointer pointing to a derived class of OMTOptimizer
   *   and this is the optimizer for targetNode
   **/
  static std::unique_ptr<OMTOptimizer> getOptimizerForNode(
      Node targetNode, bool isSigned = false);

  /**
   * Initialize an SMT subsolver for offline optimization purpose
   * @param parentSMTSolver the parental solver containing the assertions
   * @param needsTimeout specifies whether it needs timeout for each single
   *    query
   * @param timeout the timeout value, given in milliseconds (ms)
   * @return a unique_pointer of SMT subsolver
   **/
  static std::unique_ptr<SmtEngine> createOptCheckerWithTimeout(
      SmtEngine* parentSMTSolver,
      bool needsTimeout = false,
      unsigned long timeout = 0);

  /**
   * Minimize the target node with constraints encoded in parentSMTSolver
   *
   * @param parentSMTSolver an SMT solver encoding the assertions as the
   *   constraints
   * @param target the target expression to optimize
   * @return pair<OptResult, Node>: the result of optimization and the optimized
   *   value, if OptResult is OPT_UNKNOWN, value returned could be empty node or
   *   something suboptimal.
   **/
  virtual std::pair<smt::OptResult, Node> minimize(SmtEngine* parentSMTSolver,
                                                   Node target) = 0;
  /**
   * Maximize the target node with constraints encoded in parentSMTSolver
   *
   * @param parentSMTSolver an SMT solver encoding the assertions as the
   *   constraints
   * @param target the target expression to optimize
   * @return pair<OptResult, Node>: the result of optimization and the optimized
   *   value, if OptResult is OPT_UNKNOWN, value returned could be empty node or
   *   something suboptimal.
   **/
  virtual std::pair<smt::OptResult, Node> maximize(SmtEngine* parentSMTSolver,
                                                   Node target) = 0;
};

}  // namespace cvc5::omt

#endif /* CVC5__OMT__OMT_OPTIMIZER_H */
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback