FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

chore: rename the function to increase readability · diffpy/diffpy.structure@71b6a3f · GitHub

  1. diffpy
  2. diffpy.structure

Repository navigation

Commit 71b6a3f

Browse files
stevenhua0320
committed
chore: rename the function to increase readability
1 parent 40e30aa commit 71b6a3f

3 files changed

Lines changed: 19 additions & 19 deletions

File tree

‎news/deprecate-symmetryutilities-6.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
**Added:**
22

33
* Added ``_find_constraints`` method in ``SymmetryConstraints`` class
4-
* Added ``pospar_symbols`` method in ``SymmetryConstraints`` class
5-
* Added ``pospar_values`` method in ``SymmetryConstraints`` class
6-
* Added ``upar_symbols`` method in ``SymmetryConstraints`` class
7-
* Added ``upar_values`` method in ``SymmetryConstraints`` class
4+
* Added ``pos_parm_symbols`` method in ``SymmetryConstraints`` class
5+
* Added ``pos_parm_values`` method in ``SymmetryConstraints`` class
6+
* Added ``u_parm_symbols`` method in ``SymmetryConstraints`` class
7+
* Added ``u_parm_values`` method in ``SymmetryConstraints`` class
88
* Added ``u_formulas`` method in ``SymmetryConstraints`` class
99

1010
**Changed:**

‎src/diffpy/structure/symmetryutilities.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,9 +1224,9 @@ def posparSymbols(self):
12241224
12251225
Please use 'diffpy.structure.SymmetryConstraints.pospar_symbols' instead.
12261226
"""
1227-
return self.pospar_symbols()
1227+
return self.pos_parm_symbols()
12281228

1229-
def pospar_symbols(self):
1229+
def pos_parm_symbols(self):
12301230
"""Return list of standard position parameter symbols."""
12311231
return [n for n, v in self.pospars]
12321232

@@ -1237,9 +1237,9 @@ def posparValues(self):
12371237
12381238
Please use 'diffpy.structure.SymmetryConstraints.pospar_values' instead.
12391239
"""
1240-
return self.pospar_values()
1240+
return self.pos_parm_values()
12411241

1242-
def pospar_values(self):
1242+
def pos_parm_values(self):
12431243
"""Return list of position parameters values."""
12441244
return [v for n, v in self.pospars]
12451245

@@ -1265,7 +1265,7 @@ def positionFormulas(self, xyzsymbols=None):
12651265
emsg = "Not enough symbols for %i position parameters" % len(self.pospars)
12661266
raise SymmetryError(emsg)
12671267
# build translation dictionary
1268-
trsmbl = dict(zip(self.pospar_symbols(), xyzsymbols))
1268+
trsmbl = dict(zip(self.pos_parm_symbols(), xyzsymbols))
12691269

12701270
def translatesymbol(matchobj):
12711271
return trsmbl[matchobj.group(0)]
@@ -1307,9 +1307,9 @@ def UparSymbols(self):
13071307
13081308
Please use 'diffpy.structure.SymmetryConstraints.upar_symbols' instead.
13091309
"""
1310-
return self.upar_symbols()
1310+
return self.u_parm_symbols()
13111311

1312-
def upar_symbols(self):
1312+
def u_parm_symbols(self):
13131313
"""Return list of standard atom displacement parameter
13141314
symbols."""
13151315
return [n for n, v in self.Upars]
@@ -1324,7 +1324,7 @@ def UparValues(self):
13241324
"""
13251325
return [v for n, v in self.Upars]
13261326

1327-
def upar_values(self):
1327+
def u_parm_values(self):
13281328
"""Return list of atom displacement parameters values."""
13291329
return [v for n, v in self.Upars]
13301330

@@ -1362,7 +1362,7 @@ def u_formulas(self, Usymbols=None):
13621362
emsg = "Not enough symbols for %i U parameters" % len(self.Upars)
13631363
raise SymmetryError(emsg)
13641364
# build translation dictionary
1365-
trsmbl = dict(zip(self.upar_symbols(), Usymbols))
1365+
trsmbl = dict(zip(self.u_parm_symbols(), Usymbols))
13661366

13671367
def translatesymbol(matchobj):
13681368
return trsmbl[matchobj.group(0)]

‎tests/test_symmetryutilities.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -912,9 +912,9 @@ def test_upar_symbols(self):
912912
pos = [[0, 0, 0]]
913913
Uijs = numpy.zeros((1, 3, 3))
914914
sc1 = SymmetryConstraints(sg1, pos, Uijs)
915-
self.assertEqual(6, len(sc1.upar_symbols()))
915+
self.assertEqual(6, len(sc1.u_parm_symbols()))
916916
sc225 = SymmetryConstraints(sg225, pos, Uijs)
917-
self.assertEqual(["U110"], sc225.upar_symbols())
917+
self.assertEqual(["U110"], sc225.u_parm_symbols())
918918
return
919919

920920
def test_UparValues(self):
@@ -940,11 +940,11 @@ def test_upar_values(self):
940940
pos = [[0, 0, 0]]
941941
Uijs = [[[0.1, 0.4, 0.5], [0.4, 0.2, 0.6], [0.5, 0.6, 0.3]]]
942942
sc1 = SymmetryConstraints(sg1, pos, Uijs)
943-
duv = 0.1 * numpy.arange(1, 7) - sc1.upar_values()
943+
duv = 0.1 * numpy.arange(1, 7) - sc1.u_parm_values()
944944
self.assertAlmostEqual(0, max(numpy.fabs(duv)), places)
945945
sc225 = SymmetryConstraints(sg225, pos, Uijs)
946-
self.assertEqual(1, len(sc225.upar_values()))
947-
self.assertAlmostEqual(0.2, sc225.upar_values()[0], places)
946+
self.assertEqual(1, len(sc225.u_parm_values()))
947+
self.assertAlmostEqual(0.2, sc225.u_parm_values()[0], places)
948948
return
949949

950950
def test_posparSymbols_and_posparValues(self):
@@ -1108,7 +1108,7 @@ def test_pospar_symbols_and_pospar_values(params, expected_symbols, expected_val
11081108
eau = ExpandAsymmetricUnit(sg225, [[0, 0, 0]])
11091109
sc = SymmetryConstraints(sg225, eau.expandedpos)
11101110
sc.pospars = params
1111-
actual_symbols, actual_values = sc.pospar_symbols(), sc.pospar_values()
1111+
actual_symbols, actual_values = sc.pos_parm_symbols(), sc.pos_parm_values()
11121112
assert actual_symbols == expected_symbols
11131113
assert actual_values == expected_values
11141114

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL