Complete documentation of the QWAK class.
Closed this issue · 0 comments
JaimePSantos commented
Enhancement proposal
There are some functions in the QWAK class that have no documentation yet:
- Constructor: Needs description of time and timelist.
- runWalk: Add error types.
- setAdjacency: Needs full docs.
- getAdjacencyMatrix: Needs full docs.
- checkPST: Needs full docs.
- getMean: Needs full docs.
- getSndMoment: Needs full docs.
- getStDev: Needs full docs.
- getInversePartRatio: Needs full docs.
- getTransportEfficiency: Needs full docs.
- runMultipleWalks: Needs full docs.
- getProbDistList: Needs full docs.
- getProbVecList: Needs full docs.
- getWalkList: Needs full docs.
- getAmpVecList: Needs full docs.
- setTimeList: Needs full docs.
- getTimeList: Needs full docs.
Additional comments
There are many instances of double return types and im not really sure why.