choreo.segm.ODE.ImplicitRKTable.is_symmetric_pair

ImplicitRKTable.is_symmetric_pair(self, ImplicitRKTable other, double tol=1e-12)

Returns True if the pair of Runge-Kutta methods is symmetric.

The pair of methods (self, other) is inferred symmetric if its symmetry default falls under the specified tolerance tol.

Example

>>> import choreo
>>> Radau_IA = choreo.segm.multiprec_tables.ComputeImplicitRKTable(method="Radau_IA")
>>> Radau_IB = choreo.segm.multiprec_tables.ComputeImplicitRKTable(method="Radau_IB")
>>> Radau_IB.is_symmetric_pair(Radau_IB)
False
>>> Radau_IIB = choreo.segm.multiprec_tables.ComputeImplicitRKTable(method="Radau_IIB")
>>> Radau_IB.is_symmetric_pair(Radau_IIB)
True

See also

• symmetry_default()

• is_symmetric()

Parameters:

• other (ImplicitRKTable)

• tol (numpy.float64 , optional) – Tolerance on symmetry default, by default 1e-12.

Returns:

Whether the method is symmetric given the tolerance tol.

Return type:

bool