12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

more detailed comments 

Cython/Python pxd/pyx class names and argument types are a mess... Hopefully these comments help clarify something.
release/4.3a0
Duy-Nguyen Ta 2016-11-16 17:37:05 -05:00
parent 7e348a8204
commit 3f0304d067
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
wrap/Qualified.h
View File

@ -185,7 +185,9 @@ public:
return result;
}
/// the Cython class in pxd
/// name of the Cython class in pxd
/// Normal classes: innerNamespace_ClassName, e.g. GaussianFactor, noiseModel_Gaussian
/// Eigen type: Vector --> VectorXd, Matrix --> MatrixXd
std::string cythonClass() const {
if (isEigen())
return name_ + "Xd";
@ -193,11 +195,26 @@ public:
return qualifiedName("_", 1);
}
/// the Python class in pyx
/// name of Python classes in pyx
/// They have the same name with the corresponding Cython classes in pxd
/// But note that they are different: These are Python classes in the pyx file
/// To refer to a Cython class in pyx, we need to add "gtsam.", e.g. gtsam.noiseModel_Gaussian
/// see the other function pyxCythoClass for that purpose.
std::string pythonClass() const {
return cythonClass();
}
/// Python type of function arguments in pyx to interface with normal python scripts
/// Eigen types become np.ndarray (There's no Eigen types, e.g. VectorXd, in
/// Python. We have to pass in numpy array in the arguments, which will then be
/// converted to Eigen types in Cython)
std::string pythonArgumentType() const {
if (isEigen())
return "np.ndarray";
else
return qualifiedName("_", 1);
}
/// return the Cython class in pxd corresponding to a Python class in pyx
std::string pyxCythonClass() const {
if (isNonBasicType()) {