def predictor_typeendgame_set(predtype):
r"""
Sets the type of the predictor during the end game to what the
value of *predtype* represents.
A valid integer value for *predtype* lies between 0 and 9, setting
the type for the solution x and for the continuation parameter t.
The ten predictor types are
0 : secant for x, real for t;
1 : secant for x, complex for t;
2 : secant for x, geometric for t;
3 : tangent for x, real for t;
4 : tangent for x, complex for t;
5 : tangent for x, geometric for t;
6 : Hermite for x, real for t;
7 : quadratic for x, real for t;
8 : cubic for x, real for t;
9 : quartic for x, real for t.
On return is the failure code, which is zero when all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(8, predtype)
def predictor_typeendgame_set(predtype):
r"""
Sets the type of the predictor during the end game to what the
value of *predtype* represents.
A valid integer value for *predtype* lies between 0 and 9, setting
the type for the solution x and for the continuation parameter t.
The ten predictor types are
0 : secant for x, real for t;
1 : secant for x, complex for t;
2 : secant for x, geometric for t;
3 : tangent for x, real for t;
4 : tangent for x, complex for t;
5 : tangent for x, geometric for t;
6 : Hermite for x, real for t;
7 : quadratic for x, real for t;
8 : cubic for x, real for t;
9 : quartic for x, real for t.
On return is the failure code, which is zero when all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(8, predtype)
def tolerance_infsolendgame_set(tol):
r"""
Sets the tolerance threshold to decice whether a solution path
diverges to infinity, during the end game, to the value of *tol*.
On return is the failure code which is zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(34, tol)
def predictor_redfacendgame_set(redfac):
"""
Sets the value of the reduction factor to cut the step size in case of
a failed corrector step during the end game, to the value of redfac.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(14, redfac)
def predictor_maxsteponpath_set(maxstep):
r"""
Sets the maximum of the step size along a path before the end game
to the value of *maxstep*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(11, minstep)
def corrector_relcorendgame_set(tol):
r"""
Sets the tolerance on the relative correction for the corrector during
the end game, to the value of *tol*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(26, tol)
def predictor_maxtependgame_set(maxstep):
r"""
Sets the maximum of the step size during the end game
to the value of *maxstep*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(12, maxstep)
def corrector_maxiterendgame_set(maxiter):
r"""
Sets the maximum number of iterations the corrector does along
a path, before the start of the end game, to the value of *maxiter*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(20, maxiiter)
def tolerance_infsolendgame_set(tol):
"""
Sets the tolerance threshold to decice whether a solution path
diverges to infinity, during the end game, to the value of tol.
On return is the failure code which is zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(34, tol)
def corrector_relresonpath_set(tol):
r"""
Sets the tolerance on the relative residal for the corrector along
a path, before the start of the end game, to the value of *tol*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(21, tol)
def predictor_redfacendgame_set(redfac):
r"""
Sets the value of the reduction factor to cut the step size in case of
a failed corrector step during the end game, to the value of *redfac*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(14, redfac)
def corrector_abscoronpath_set(tol):
"""
Sets the tolerance on the absolute correction for the corrector along
a path, before the start of the end game, to the value of tol.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(27, tol)
def corrector_absresendgame_set(tol):
"""
Sets the tolerance on the absolute residal for the corrector during
the end game, to the value of tol.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(28, tol)
def corrector_absresendgame_set(tol):
r"""
Sets the tolerance on the absolute residal for the corrector during
the end game, to the value of *tol*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(28, tol)
def corrector_maxiterendgame_set(maxiter):
"""
Sets the maximum number of iterations the corrector does along
a path, before the start of the end game, to the value of maxiter.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(20, maxiiter)
def predictor_maxtependgame_set(maxstep):
"""
Sets the maximum of the step size during the end game
to the value of maxstep.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(12, maxstep)
def predictor_maxsteponpath_set(maxstep):
"""
Sets the maximum of the step size along a path before the end game
to the value of maxstep.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(11, minstep)
def corrector_abscoronpath_set(tol):
r"""
Sets the tolerance on the absolute correction for the corrector along
a path, before the start of the end game, to the value of *tol*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(27, tol)
def order_endgame_extrapolator_set(ord):
r"""
Sets the order of the extrapolator to estimate the winding number
in a polyhedral end game to the value of *ord*.
If the order *ord* is zero, then no polyhedral end game will be applied.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(5, ord)
def tolerance_clustsolendgame_set(tol):
"""
Sets the tolerance on the distance between two solutions to decide
whether two solutions are clustered during the end game,
to the value of tol.
On return is the failure code which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(32, tol)
def corrector_relresonpath_set(tol):
"""
Sets the tolerance on the relative residal for the corrector along
a path, before the start of the end game, to the value of tol.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(21, tol)
def max_steps_set(mxs):
"""
Sets the maximum number of steps the path tracker will perform
to reach the end of a solution path to mxs. For paths that diverge to
infinity are often truncated beore reaching extreme values.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(3, mxs)
def predictor_expfacendgame_set(expfac):
"""
Sets the value of the expansion factor to increase the step size in
case of a successful corrector stag, during the end game,
to the value of expfac.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(16, expfac)
def corrector_relcorendgame_set(tol):
"""
Sets the tolerance on the relative correction for the corrector during
the end game, to the value of tol.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(26, tol)
def order_endgame_extrapolator_set(ord):
"""
Sets the order of the extrapolator to estimate the winding number
in a polyhedral end game to the value of ord.
If the order is zero, then no polyhedral end game will be applied.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(5, ord)
def condition_level_set(lvl):
"""
Sets the parameter that represents the difficulty level of the
homotopy to the value of lvl. The default level equals zero,
higher values lead to smaller tolerances.
On return is the failure code, which is zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(1, lvl)
def tolerance_clustsolonpath_set(tol):
r"""
Sets the tolerance on the distance between two solutions to decide
whether two solutions are clustered along a path, before the end game,
to the value of *tol*.
On return is the failure code which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(31, tol)
def tolerance_rcondendgame_set(tol):
"""
Sets the tolerance on the inverse condition number of the Jacobian
matrix of a solution along a path, before the end game, to decide
whether a solution is singular, to the value of tol.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(30, tol)
def predictor_redfaconpath_set(redfac):
r"""
Sets the value of the reduction factor to cut the step size in case of
a failed corrector step, along a path, before the end game, to the
value of *redfac*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(13, redfac)
def max_steps_set(mxs):
r"""
Sets the maximum number of steps the path tracker will perform
to reach the end of a solution path to *mxs*. For paths that diverge to
infinity are often truncated beore reaching extreme values.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(3, mxs)
def tolerance_clustsolendgame_set(tol):
r"""
Sets the tolerance on the distance between two solutions to decide
whether two solutions are clustered during the end game,
to the value of *tol*.
On return is the failure code which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(32, tol)
def predictor_expfacendgame_set(expfac):
r"""
Sets the value of the expansion factor to increase the step size in
case of a successful corrector stag, during the end game,
to the value of *expfac*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(16, expfac)
def tolerance_rcondendgame_set(tol):
r"""
Sets the tolerance on the inverse condition number of the Jacobian
matrix of a solution along a path, before the end game, to decide
whether a solution is singular, to the value of *tol*.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(30, tol)
def condition_level_set(lvl):
r"""
Sets the parameter that represents the difficulty level of the
homotopy to the value of *lvl*. The default level equals zero,
higher values lead to smaller tolerances.
On return is the failure code, which is zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(1, lvl)
def predictor_redfaconpath_set(redfac):
"""
Sets the value of the reduction factor to cut the step size in case of
a failed corrector step, along a path, before the end game, to the
value of redfac.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(13, redfac)
def tolerance_clustsolonpath_set(tol):
"""
Sets the tolerance on the distance between two solutions to decide
whether two solutions are clustered along a path, before the end game,
to the value of tol.
On return is the failure code which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(31, tol)
def distance_to_endgame_set(dst):
"""
Sets the distance to start the end game to the value of dst.
During the end game, the path tracker may apply tolerances that are
more severe as the solution paths get more interesting near the end.
The default value is 0.1.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(4, dst)
def maxnum_reruns_set(mrr):
"""
Sets the value of the maximum number of path reruns to the value of mrr.
If path jumping is detected, then the clustered paths are retracked
with more severe values of the tolerances.
The default value equals one.
On return is the failure code, which is zero when all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(6, mrr)
def predictor_exptrsendgame_set(exptrs):
"""
Sets the value of the expansion threshold for the step size control,
during the end game, to the value of exptrs.
The expansion threshold is the number of consecutive successful
corrector stages that must be met before the step size is increased.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(18, exptrs)
def predictor_exptrsendgame_set(exptrs):
r"""
Sets the value of the expansion threshold for the step size control,
during the end game, to the value of *exptrs*.
The expansion threshold is the number of consecutive successful
corrector stages that must be met before the step size is increased.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(18, exptrs)
def distance_to_endgame_set(dst):
r"""
Sets the distance to start the end game to the value of *dst*.
During the end game, the path tracker may apply tolerances that are
more severe as the solution paths get more interesting near the end.
The default value is 0.1.
On return is the failure code, which equals zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(4, dst)
def maxnum_reruns_set(mrr):
"""
Sets the value of the maximum number of path reruns to the value of mrr.
If path jumping is detected, then the clustered paths are retracked
with more severe values of the tolerances.
The default value equals one.
On return is the failure code, which is zero when all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(6, mrr)
def track_simultaneously_set(nbr):
r"""
Sets the number of paths that are tracked simultaneously, for the
same discretization of the interval of the continuation parameter,
to the value of *nbr*.
The default value equals one. Increasing this value avoids path crossing,
also called path jumping. This jumping happens when the approximated
points on one path transition to approximated points on another path.
On return in the failure code, which is zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(2, nbr)
def track_simultaneously_set(nbr):
"""
Sets the number of paths that are tracked simultaneously, for the
same discretization of the interval of the continuation parameter,
to the value of nbr.
The default value equals one. Increasing this value avoids path crossing,
also called path jumping. This jumping happens when the approximated
points on one path transition to approximated points on another path.
On return in the failure code, which is zero if all went well.
"""
from phcpy.phcpy2c3 import py2c_set_value_of_continuation_parameter as set
return set(2, nbr)
