API-level function documentation#
In this chapter, we summarise the I/O of all Matlab and code underpinning PathFinder. Below is a list of all Matlab and files used in PathFinder (excluding example files).
In the description of each subroutine, we use similar notation as in [Gibbs et al., 2024], where further description can be found.
PathFinder.mPathFinderQuad.maddPaths.mcompileAll.mbisection.mcheckEndpointWidth.mdeleteRedundantExits.mgetBallDeets.mgetExteriorBalls.mgetSmallestSupsetBallinAball.mBall.mbeyondNoReturn.mgetContours.mJordanRotate.msdPathODEeulerExtendCoarsePath.msdPathODEeuler.msdQuadODEeulerCorrection.mContourSD.mcomputeGauss.mfliterPaths.mdgausLagHC.mgausLegHC.mgauss.mgaussQuadComplexharcCodeQuadratureGaulag.mharcCodeQuadratureGauleg.mlinearPhaseNSD.mmakeQuad.mquadGaussLaguerre.mrJacobi.mrLaguerre.minitLog.mlogContourDetails.mlogMexUsage.mlogQuadratureDetails.mswitchWindowsCompiler.mcheckForPackage.mcheckInputs.mgetHandlesFromCoeffs.moptionalExtras.musingOctave.mfillCircle.mplotAll.mplotGraph.mplotMain.mgetInfoFromPhase.mgetRGivenTheta.mgetRStar.mgetSteepestExitsOnBall.mplanBisection.mshortestInfinitePath.mDijkstra.m
For the C code used to generate the MEX functions, detailed information about inputs and outputs can be found in the comments of the .c and .h files.