/
IValue.java
117 lines (94 loc) · 3.75 KB
/
IValue.java
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*******************************************************************************
* Copyright (c) 2019 Microsoft Research. All rights reserved.
*
* The MIT License (MIT)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is furnished to do
* so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* Contributors:
* Markus Alexander Kuppe - initial API and implementation
******************************************************************************/
package tlc2.value;
import java.io.IOException;
import tla2sany.semantic.SemanticNode;
import tlc2.tool.coverage.CostModel;
public interface IValue extends Comparable<Object> {
/* This method compares this with val. */
@Override
int compareTo(Object val);
void write(IValueOutputStream vos) throws IOException;
IValue setCostModel(CostModel cm);
CostModel getCostModel();
void setSource(SemanticNode semanticNode);
SemanticNode getSource();
boolean hasSource();
/* MAK 09/17/2019: Introduced to guarantee that Value instances are
* fully initialized when created by the SpecProcessor (as opposed
* to by workers during state space exploration).
*/
/**
* Fully initialize this instance which includes:
* - deep normalization
* - conversion and caching iff defined by the sub-class
*
* No further mutation of this instance should be required
* for any evaluation whatsoever.
*
* Afterwards, isNormalized below returns true (it does not
* return true for all sub-classes when only deepNormalized
* is executed)!
*
* see comment in UnionValue#deepNormalize too
*/
default void initialize() {
this.deepNormalize();
// Execute fingerprint code path to internally trigger convertAndCache iff
// defined (0L parameter is not relevant)
this.fingerPrint(0L);
}
/**
* This method normalizes (destructively) the representation of
* the value. It is essential for equality comparison.
*/
boolean isNormalized();
/* Fully normalize this (composite) value. */
void deepNormalize();
/* This method returns the fingerprint of this value. */
long fingerPrint(long fp);
/**
* This method returns the value permuted by the permutation. It
* returns this if nothing is permuted.
*/
IValue permute(IMVPerm perm);
/* This method returns true iff the value is finite. */
boolean isFinite();
/* This method returns the size of the value. */
int size();
/* This method returns true iff the value is fully defined. */
boolean isDefined();
/* This method makes a real deep copy of this. */
IValue deepCopy();
/**
* This abstract method returns a string representation of this
* value. Each subclass must provide its own implementation.
*/
StringBuffer toString(StringBuffer sb, int offset, boolean swallow);
/* The string representation of this value */
String toString();
String toString(String delim);
}