Skip to content

Commit 6fbf15d

Browse files
committed
250406.215519.CST Documentation: fix grammar mistakes and sentences with ambiguity
1 parent ebf15cf commit 6fbf15d

File tree

22 files changed

+47
-49
lines changed

22 files changed

+47
-49
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ large constraint violation even though the starting point is feasible.
266266
### Improvements
267267

268268
Thanks to the improvements introduced into the new implementation, PRIMA
269-
generally produces better solutions with less function evaluations compared with Powell's Fortran 77 implementation.
269+
generally produces better solutions with fewer function evaluations compared with Powell's Fortran 77 implementation.
270270
This makes PRIMA preferable **if function evaluations are expensive**,
271271
which is typically the case for [derivative-free optimization problems](https://github.com/orgs/libprima/discussions/145).
272272
However, if function evaluations are not the dominant cost in your application (e.g., a function
@@ -345,7 +345,7 @@ support from the optimization community and beyond.
345345

346346
The development of PRIMA would have been a mission impossible without the groundwork laid by the [PDFO](https://www.pdfo.net)
347347
package of [Tom M. Ragonneau](https://ragonneau.github.io) and Zaikun Zhang.
348-
PDFO is Chapter 3 of Ragonneau's [thesis](https://theses.lib.polyu.edu.hk/handle/200/12294) co-supervised by Zaikun Zhang
348+
PDFO is Chapter 3 of Ragonneau's [thesis](https://theses.lib.polyu.edu.hk/handle/200/12294) co-supervised by Zaikun Zhang
349349
and Professor [Xiaojun Chen](https://www.polyu.edu.hk/ama/staff/xjchen/ChenXJ.htm),
350350
with financial support from the [Hong Kong Ph.D. Fellowship Scheme](https://cerg1.ugc.edu.hk/hkpfs/index.html) (ref. PF18-24698).
351351

pyprima/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
## About
22

3-
This is a Python translation of the [modern-Fortran reference implementation](https://github.com/libprima/prima/tree/main/fortran)
3+
This is a Python translation of [Zaikun Zhang](https://www.zhangzk.net)'s [modern-Fortran reference implementation](https://github.com/libprima/prima/tree/main/fortran)
44
for Powell's derivative-free optimization solvers, which is available at `fortran/` under the root directory.
55
It is supposed to be a faithful translation, [producing bit-for-bit identical results](https://github.com/scipy/scipy/pull/22350#issue-2795978526).
6-
as the Fortran reference implementation
6+
as the modern-Fortran reference implementation.
77
If you notice a difference, [raise an issue](https://github.com/libprima/prima/issues/new).
88

99
Due to [bug-fixes](https://github.com/libprima/prima#bug-fixes) and [improvements](https://github.com/libprima/prima#improvements),
@@ -13,7 +13,7 @@ even though the algorithms are essentially the same. Therefore, it is important
1313
PRIMA rather than the original solvers if you want your results to be reproducible.
1414

1515
Compared to Powell's Fortran 77 implementation, the modern-Fortran implementation and hence any faithful
16-
translation like this one generally [produce better solutions with less function evaluations](https://github.com/libprima/prima#improvements),
16+
translation like this one generally [produce better solutions with fewer function evaluations](https://github.com/libprima/prima#improvements),
1717
making them preferable for [applications with expensive function evaluations](https://github.com/orgs/libprima/discussions/145).
1818
However, if function evaluations are not the dominant cost in your application, the Fortran 77
1919
solvers are likely to be faster, as they are more efficient in terms of memory usage and flops
@@ -32,7 +32,7 @@ To develop, `cd` into the `src` directory and run
3232

3333
```pip install --editable .```
3434

35-
This will install prima locally in an editable fashion. From there you can run the examples/cobyla/cobyla_example.py (from any directory) and go from there.
35+
This will install PRIMA locally in an editable fashion. From there you can run the examples/cobyla/cobyla_example.py (from any directory) and go from there.
3636

3737
### Style notes
3838

pyprima/src/pyprima/cobyla/cobyla.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
'''
22
This module provides Powell's COBYLA algorithm.
33
4-
Translated from the modern-Fortran reference implementation in PRIMA by Zaikun ZHANG (www.zhangzk.net).
4+
Translated from Zaikun Zhang's modern-Fortran reference implementation in PRIMA.
55
66
Dedicated to late Professor M. J. D. Powell FRS (1936--2015).
77
8-
Python implementation by Nickolai Belakovski
8+
Python translation by Nickolai Belakovski.
99
1010
N.B.:
1111
@@ -15,7 +15,7 @@
1515
you are using PRIMA rather than the original solvers if you want your results to be reproducible.
1616
1717
2. Compared to Powell's Fortran 77 implementation, the modern-Fortran implementation and hence any
18-
faithful translation like this one generally produce better solutions with less function evaluations,
18+
faithful translation like this one generally produce better solutions with fewer function evaluations,
1919
making them preferable for applications with expensive function evaluations. However, if function
2020
evaluations are not the dominant cost in your application, the Fortran 77 solvers are likely to be
2121
faster, as they are more efficient in terms of memory usage and flops thanks to the careful and

pyprima/src/pyprima/cobyla/cobylb.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
'''
22
This module performs the major calculations of COBYLA.
33
4-
Translated from the modern-Fortran reference implementation in PRIMA by Zaikun ZHANG (www.zhangzk.net).
4+
Translated from Zaikun Zhang's modern-Fortran reference implementation in PRIMA.
55
66
Dedicated to late Professor M. J. D. Powell FRS (1936--2015).
77
8-
Python implementation by Nickolai Belakovski
8+
Python translation by Nickolai Belakovski.
99
'''
1010

1111
import numpy as np

pyprima/src/pyprima/cobyla/geometry.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
'''
22
This module contains subroutines concerning the geometry-improving of the interpolation set.
33
4-
Translated from the modern-Fortran reference implementation in PRIMA by Zaikun ZHANG (www.zhangzk.net).
4+
Translated from Zaikun Zhang's modern-Fortran reference implementation in PRIMA.
55
66
Dedicated to late Professor M. J. D. Powell FRS (1936--2015).
77
8-
Python implementation by Nickolai Belakovski
8+
Python translation by Nickolai Belakovski.
99
'''
1010

1111
from ..common.consts import DEBUGGING

pyprima/src/pyprima/cobyla/initialize.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
'''
22
This module contains subroutines for initialization.
33
4-
Translated from the modern-Fortran reference implementation in PRIMA by Zaikun ZHANG (www.zhangzk.net).
4+
Translated from Zaikun Zhang's modern-Fortran reference implementation in PRIMA.
55
66
Dedicated to late Professor M. J. D. Powell FRS (1936--2015).
77
8-
Python implementation by Nickolai Belakovski
8+
Python translation by Nickolai Belakovski.
99
'''
1010

1111
from ..common.checkbreak import checkbreak_con

pyprima/src/pyprima/cobyla/trustregion.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
'''
22
This module provides subroutines concerning the trust-region calculations of COBYLA.
33
4-
Translated from the modern-Fortran reference implementation in PRIMA by Zaikun ZHANG (www.zhangzk.net).
4+
Translated from Zaikun Zhang's modern-Fortran reference implementation in PRIMA.
55
66
Dedicated to late Professor M. J. D. Powell FRS (1936--2015).
77
8-
Python implementation by Nickolai Belakovski
8+
Python translation by Nickolai Belakovski.
99
'''
1010

1111
import numpy as np

pyprima/src/pyprima/cobyla/update.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
'''
22
This module contains subroutines concerning the update of the interpolation set.
33
4-
Translated from the modern-Fortran reference implementation in PRIMA by Zaikun ZHANG (www.zhangzk.net).
4+
Translated from Zaikun Zhang's modern-Fortran reference implementation in PRIMA.
55
66
Dedicated to late Professor M. J. D. Powell FRS (1936--2015).
77
8-
Python implementation by Nickolai Belakovski
8+
Python translation by Nickolai Belakovski.
99
'''
1010

1111
from ..common.consts import DEBUGGING

pyprima/src/pyprima/common/_project.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,8 @@ def _project(x0, lb, ub, constraints):
4141
4242
Authors
4343
-------
44-
Tom M. RAGONNEAU ([email protected])
45-
and Zaikun ZHANG ([email protected])
46-
Department of Applied Mathematics,
47-
The Hong Kong Polytechnic University.
44+
Tom M. RAGONNEAU (ragonneau.github.io)
45+
and Zaikun ZHANG (www.zhangzk.net)
4846
4947
Dedicated to the late Professor M. J. D. Powell FRS (1936--2015).
5048
"""

pyprima/src/pyprima/common/checkbreak.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
'''
22
This module checks whether to break out of the solver loop.
33
4-
Translated from the modern-Fortran reference implementation in PRIMA by Zaikun ZHANG (www.zhangzk.net).
4+
Translated from Zaikun Zhang's modern-Fortran reference implementation in PRIMA.
55
66
Dedicated to late Professor M. J. D. Powell FRS (1936--2015).
77
8-
Python implementation by Nickolai Belakovski
8+
Python translation by Nickolai Belakovski.
99
'''
1010

1111
from .infos import INFO_DEFAULT, NAN_INF_X, NAN_INF_F, FTARGET_ACHIEVED, MAXFUN_REACHED

0 commit comments

Comments
 (0)