Grcov report - sat_direct

1

// https://conjure-cp.github.io/conjure-oxide/docs/conjure_core/representation/trait.Representation.html

2

use conjure_cp::ast::GroundDomain;

3

use conjure_cp::bug;

4

use conjure_cp::{

5

    ast::{Atom, DeclarationPtr, Domain, Expression, Literal, Metadata, Name, SymbolTable},

6

    register_representation,

7

    representation::Representation,

8

    rule_engine::ApplicationError,

9

};

10

11

register_representation!(SatDirectInt, "sat_direct_int");

12

13

#[derive(Clone, Debug)]

14

pub struct SatDirectInt {

15

    src_var: Name,

16

    upper_bound: i32,

17

    lower_bound: i32,

18

19

20

impl SatDirectInt {

21

    /// Returns the names of the boolean variables used in the direct encoding.

22

    fn names(&self) -> impl Iterator<Item = Name> + '_ {

23

        (self.lower_bound..=self.upper_bound).map(|index| self.index_to_name(index))

24

25

26

    /// Gets the representation variable name corresponding to a concrete integer value.

27

    fn index_to_name(&self, index: i32) -> Name {

28

        Name::Represented(Box::new((

29

            self.src_var.clone(),

30

            self.repr_name().into(),

31

            format!("{index}").into(), // stored as _00, _01, ...

32

)))

33

34

35

36

impl Representation for SatDirectInt {

37

    /// Creates a direct int representation object for the given name.

38

    fn init(name: &Name, symtab: &SymbolTable) -> Option<Self> {

39

        let domain = symtab.resolve_domain(name)?;

40

41

        if !domain.is_finite() {

42

            return None;

43

44

45

        let GroundDomain::Int(ranges) = domain.as_ref() else {

46

            return None;

47

};

48

49

        // Determine min/max and return None if range is unbounded

50

        let (min, max) =

51

            ranges

52

                .iter()

53

                .try_fold((i32::MAX, i32::MIN), |(min_a, max_b), range| {

54

                    let lb = range.low()?;

55

                    let ub = range.high()?;

56

                    Some((min_a.min(*lb), max_b.max(*ub)))

57

                })?;

58

59

        Some(SatDirectInt {

60

            src_var: name.clone(),

61

            lower_bound: min,

62

            upper_bound: max,

63

})

64

65

66

    /// The variable being represented.

67

    fn variable_name(&self) -> &Name {

68

        &self.src_var

69

70

71

    fn value_down(

72

        &self,

73

        _value: Literal,

74

    ) -> Result<std::collections::BTreeMap<Name, Literal>, ApplicationError> {

75

        // NOTE: It's unclear where and when `value_down` would be called for

76

        // direct encoding. This is also never called in log encoding, so we

77

        // deliberately fail here to surface unexpected usage.

78

        bug!("value_down is not implemented for direct encoding and should not be called")

79

80

81

    /// Given the values for its boolean representation variables, creates an assignment for `self` - the integer form.

82

    fn value_up(

83

        &self,

84

        values: &std::collections::BTreeMap<Name, Literal>,

85

    ) -> Result<Literal, ApplicationError> {

86

        let mut found_value: Option<i32> = None;

87

88

        for value_candidate in self.lower_bound..=self.upper_bound {

89

            let name = self.index_to_name(value_candidate);

90

            let value_literal = values

91

                .get(&name)

92

                .ok_or(ApplicationError::RuleNotApplicable)?;

93

94

            let is_true = match value_literal {

95

                Literal::Int(1) | Literal::Bool(true) => true,

96

                Literal::Int(0) | Literal::Bool(false) => false,

97

                _ => return Err(ApplicationError::RuleNotApplicable),

98

};

99

100

            if is_true {

101

                if found_value.is_some() {

102

                    // More than one variable is true, which is an error for direct encoding

103

                    return Err(ApplicationError::RuleNotApplicable);

104

105

                found_value = Some(value_candidate);

106

107

108

109

        found_value

110

            .map(Literal::Int)

111

            .ok_or(ApplicationError::RuleNotApplicable)

112

113

114

    /// Returns [`Expression`]s representing each boolean representation variable.

115

    fn expression_down(

116

        &self,

117

        st: &SymbolTable,

118

    ) -> Result<std::collections::BTreeMap<Name, Expression>, ApplicationError> {

119

        Ok(self

120

            .names()

121

            .enumerate()

122

            .map(|(index, name)| {

123

                let decl = st.lookup(&name).unwrap();

124

125

                    // Machine names are used so that the derived ordering matches the correct ordering of the representation variables

126

                    Name::Machine(index as i32),

127

                    Expression::Atomic(

128

                        Metadata::new(),

129

                        Atom::Reference(conjure_cp::ast::Reference { ptr: decl }),

130

),

131

132

})

133

            .collect())

134

135

136

    /// Creates declarations for the boolean representation variables of `self`.

137

    fn declaration_down(&self) -> Result<Vec<DeclarationPtr>, ApplicationError> {

138

        let temp_a = self

139

            .names()

140

            .map(|name| DeclarationPtr::new_find(name, Domain::bool()))

141

            .collect();

142

143

        Ok(temp_a)

144

145

146

    /// The rule name for this representation.

147

    fn repr_name(&self) -> &str {

148

        "sat_direct_int"

149

150

151

    /// Makes a clone of `self` into a `Representation` trait object.

152

    fn box_clone(&self) -> Box<dyn Representation> {

153

        Box::new(self.clone()) as _

154

155