LSST Applications g0f08755f38+9c285cab97,g1635faa6d4+13f3999e92,g1653933729+a8ce1bb630,g1a0ca8cf93+bf6eb00ceb,g28da252d5a+0829b12dee,g29321ee8c0+5700dc9eac,g2bbee38e9b+9634bc57db,g2bc492864f+9634bc57db,g2cdde0e794+c2c89b37c4,g3156d2b45e+41e33cbcdc,g347aa1857d+9634bc57db,g35bb328faa+a8ce1bb630,g3a166c0a6a+9634bc57db,g3e281a1b8c+9f2c4e2fc3,g414038480c+077ccc18e7,g41af890bb2+fde0dd39b6,g5fbc88fb19+17cd334064,g781aacb6e4+a8ce1bb630,g80478fca09+55a9465950,g82479be7b0+d730eedb7d,g858d7b2824+9c285cab97,g9125e01d80+a8ce1bb630,g9726552aa6+10f999ec6a,ga5288a1d22+2a84bb7594,gacf8899fa4+c69c5206e8,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+9634bc57db,gcf0d15dbbd+4b7d09cae4,gda3e153d99+9c285cab97,gda6a2b7d83+4b7d09cae4,gdaeeff99f8+1711a396fd,ge2409df99d+5e831397f4,ge79ae78c31+9634bc57db,gf0baf85859+147a0692ba,gf3967379c6+41c94011de,gf3fb38a9a8+8f07a9901b,gfb92a5be7c+9c285cab97,w.2024.46
LSST Data Management Base Package
Loading...
Searching...
No Matches
Functions
lsst.pex.config.comparison Namespace Reference

Functions

 getComparisonName (name1, name2)
 
 compareScalars (name, v1, v2, output, rtol=1e-8, atol=1e-8, dtype=None)
 
 compareConfigs (name, c1, c2, shortcut=True, rtol=1e-8, atol=1e-8, output=None)
 

Detailed Description

Helper functions for comparing `lsst.pex.config.Config` instancess.

Theses function should be use for any comparison in a `lsst.pex.Config.compare`
or `lsst.pex.config.Field._compare` implementation, as they take care of
writing messages as well as floating-point comparisons and shortcuts.

Function Documentation

◆ compareConfigs()

lsst.pex.config.comparison.compareConfigs ( name,
c1,
c2,
shortcut = True,
rtol = 1e-8,
atol = 1e-8,
output = None ) 
Compare two `lsst.pex.config.Config` instances for equality.

This function is a helper for `lsst.pex.config.Config.compare`.

Parameters
----------
name : `str`
    Name to use when reporting differences, typically created by
    `getComparisonName`.
c1 : `lsst.pex.config.Config`
    Left-hand side config to compare.
c2 : `lsst.pex.config.Config`
    Right-hand side config to compare.
shortcut : `bool`, optional
    If `True`, return as soon as an inequality is found. Default is `True`.
rtol : `float`, optional
    Relative tolerance for floating point comparisons.
atol : `float`, optional
    Absolute tolerance for floating point comparisons.
output : callable, optional
    A callable that takes a string, used (possibly repeatedly) to report
    inequalities. For example: `print`.

Returns
-------
areEqual : `bool`
    `True` when the two `lsst.pex.config.Config` instances are equal.
    `False` if there is an inequality.

See Also
--------
lsst.pex.config.compareScalars

Notes
-----
Floating point comparisons are performed by `numpy.allclose`.

If ``c1`` or ``c2`` contain `~lsst.pex.config.RegistryField` or
`~lsst.pex.config.ConfigChoiceField` instances, *unselected*
`~lsst.pex.config.Config` instances will not be compared.

Definition at line 111 of file comparison.py.

111def compareConfigs(name, c1, c2, shortcut=True, rtol=1e-8, atol=1e-8, output=None):
112 """Compare two `lsst.pex.config.Config` instances for equality.
113
114 This function is a helper for `lsst.pex.config.Config.compare`.
115
116 Parameters
117 ----------
118 name : `str`
119 Name to use when reporting differences, typically created by
120 `getComparisonName`.
121 c1 : `lsst.pex.config.Config`
122 Left-hand side config to compare.
123 c2 : `lsst.pex.config.Config`
124 Right-hand side config to compare.
125 shortcut : `bool`, optional
126 If `True`, return as soon as an inequality is found. Default is `True`.
127 rtol : `float`, optional
128 Relative tolerance for floating point comparisons.
129 atol : `float`, optional
130 Absolute tolerance for floating point comparisons.
131 output : callable, optional
132 A callable that takes a string, used (possibly repeatedly) to report
133 inequalities. For example: `print`.
134
135 Returns
136 -------
137 areEqual : `bool`
138 `True` when the two `lsst.pex.config.Config` instances are equal.
139 `False` if there is an inequality.
140
141 See Also
142 --------
143 lsst.pex.config.compareScalars
144
145 Notes
146 -----
147 Floating point comparisons are performed by `numpy.allclose`.
148
149 If ``c1`` or ``c2`` contain `~lsst.pex.config.RegistryField` or
150 `~lsst.pex.config.ConfigChoiceField` instances, *unselected*
151 `~lsst.pex.config.Config` instances will not be compared.
152 """
153 assert name is not None
154 if c1 is None:
155 if c2 is None:
156 return True
157 else:
158 if output is not None:
159 output(f"LHS is None for {name}")
160 return False
161 else:
162 if c2 is None:
163 if output is not None:
164 output(f"RHS is None for {name}")
165 return False
166 if type(c1) is not type(c2):
167 if output is not None:
168 output(f"Config types do not match for {name}: {type(c1)} != {type(c2)}")
169 return False
170 equal = True
171 for field in c1._fields.values():
172 result = field._compare(c1, c2, shortcut=shortcut, rtol=rtol, atol=atol, output=output)
173 if not result and shortcut:
174 return False
175 equal = equal and result
176 return equal

◆ compareScalars()

lsst.pex.config.comparison.compareScalars ( name,
v1,
v2,
output,
rtol = 1e-8,
atol = 1e-8,
dtype = None ) 
Compare two scalar values for equality.

This function is a helper for `lsst.pex.config.Config.compare`.

Parameters
----------
name : `str`
    Name to use when reporting differences, typically created by
    `getComparisonName`.
v1 : object
    Left-hand side value to compare.
v2 : object
    Right-hand side value to compare.
output : callable or `None`
    A callable that takes a string, used (possibly repeatedly) to report
    inequalities (for example, `print`). Set to `None` to disable output.
rtol : `float`, optional
    Relative tolerance for floating point comparisons.
atol : `float`, optional
    Absolute tolerance for floating point comparisons.
dtype : class, optional
    Data type of values for comparison. May be `None` if values are not
    floating-point.

Returns
-------
areEqual : `bool`
    `True` if the values are equal, `False` if they are not.

See Also
--------
lsst.pex.config.compareConfigs

Notes
-----
Floating point comparisons are performed by `numpy.allclose`.

Definition at line 62 of file comparison.py.

62def compareScalars(name, v1, v2, output, rtol=1e-8, atol=1e-8, dtype=None):
63 """Compare two scalar values for equality.
64
65 This function is a helper for `lsst.pex.config.Config.compare`.
66
67 Parameters
68 ----------
69 name : `str`
70 Name to use when reporting differences, typically created by
71 `getComparisonName`.
72 v1 : object
73 Left-hand side value to compare.
74 v2 : object
75 Right-hand side value to compare.
76 output : callable or `None`
77 A callable that takes a string, used (possibly repeatedly) to report
78 inequalities (for example, `print`). Set to `None` to disable output.
79 rtol : `float`, optional
80 Relative tolerance for floating point comparisons.
81 atol : `float`, optional
82 Absolute tolerance for floating point comparisons.
83 dtype : class, optional
84 Data type of values for comparison. May be `None` if values are not
85 floating-point.
86
87 Returns
88 -------
89 areEqual : `bool`
90 `True` if the values are equal, `False` if they are not.
91
92 See Also
93 --------
94 lsst.pex.config.compareConfigs
95
96 Notes
97 -----
98 Floating point comparisons are performed by `numpy.allclose`.
99 """
100 if v1 is None or v2 is None:
101 result = v1 == v2
102 elif dtype in (float, complex):
103 result = numpy.allclose(v1, v2, rtol=rtol, atol=atol) or (numpy.isnan(v1) and numpy.isnan(v2))
104 else:
105 result = v1 == v2
106 if not result and output is not None:
107 output(f"Inequality in {name}: {v1!r} != {v2!r}")
108 return result
109
110

◆ getComparisonName()

lsst.pex.config.comparison.getComparisonName ( name1,
name2 ) 
Create a comparison name that is used for printed output of comparisons.

Parameters
----------
name1 : `str`
    Name of the first configuration.
name2 : `str`
    Name of the second configuration.

Returns
-------
name : `str`
    When ``name1`` and ``name2`` are equal, the returned name is
    simply one of the names. When they are different the returned name is
    formatted as ``"{name1} / {name2}"``.

Definition at line 40 of file comparison.py.

40def getComparisonName(name1, name2):
41 """Create a comparison name that is used for printed output of comparisons.
42
43 Parameters
44 ----------
45 name1 : `str`
46 Name of the first configuration.
47 name2 : `str`
48 Name of the second configuration.
49
50 Returns
51 -------
52 name : `str`
53 When ``name1`` and ``name2`` are equal, the returned name is
54 simply one of the names. When they are different the returned name is
55 formatted as ``"{name1} / {name2}"``.
56 """
57 if name1 != name2:
58 return f"{name1} / {name2}"
59 return name1
60
61
Generated on Wed Nov 20 2024 09:02:52 for LSST Applications by doxygen 1.10.0