boost_mirror/histogram
1
0
Fork 0
mirror of https://github.com/boostorg/histogram.git synced 2025-05-11 05:07:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

more docstrings

Browse Source
This commit is contained in:
Hans Dembinski 2016-04-14 23:37:56 -04:00
parent f2b51bcb11
commit 007e280480
2 changed files with 39 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/python/basic_histogram.cpp
View File

@ -271,6 +271,7 @@ basic_histogram_axis(const basic_histogram& self, unsigned i)
void register_basic_histogram() { void register_basic_histogram() {
using namespace python; using namespace python;
using python::arg; using python::arg;
docstring_options dopt(true, true, false);
// used to pass arguments from raw python init to specialized C++ constructors // used to pass arguments from raw python init to specialized C++ constructors
class_<std::vector<double> >("vector_double", no_init); class_<std::vector<double> >("vector_double", no_init);
@ -314,10 +315,18 @@ void register_basic_histogram() {
; ;
class_<basic_histogram>("basic_histogram", no_init) class_<basic_histogram>("basic_histogram", no_init)
.add_property("dim", &basic_histogram::dim) .add_property("dim", &basic_histogram::dim,
.def("bins", &basic_histogram::bins) ":return: dimensions of the histogram")
.def("shape", &basic_histogram::shape) .def("shape", &basic_histogram::shape,
.def("axis", basic_histogram_axis) ":param int i: index of the axis\n"
":return: number of count fields for axis i\n"
" (bins + 2 if underflow and overflow"
" bins are enabled, otherwise equal to bins",
args("self", "i"))
.def("axis", basic_histogram_axis,
":param int i: index of the axis\n"
":return: axis object for axis i",
args("self", "i"))
; ;
} }

32
src/python/histogram.cpp
View File

@ -220,20 +220,40 @@ public:
void register_histogram() void register_histogram()
{ {
using namespace python; using namespace python;
docstring_options dopt(true, true, false);
class_< class_<
histogram, bases<basic_histogram>, histogram, bases<basic_histogram>,
shared_ptr<histogram> shared_ptr<histogram>
>("histogram", no_init) >("histogram",
.def("__init__", raw_function(histogram_init)) "N-dimensional histogram for real-valued data.",
no_init)
.def("__init__", raw_function(histogram_init),
":param axis args: axis objects"
"\nPass one or more axis objects to define"
"\nthe dimensions of the histogram.")
// shadowed C++ ctors // shadowed C++ ctors
.def(init<const basic_histogram::axes_type&>()) .def(init<const basic_histogram::axes_type&>())
.add_property("__array_interface__", &histogram_access::histogram_array_interface) .add_property("__array_interface__",
.def("fill", raw_function(histogram_fill)) &histogram_access::histogram_array_interface)
.def("fill", raw_function(histogram_fill),
"Pass a sequence of values with a length n is"
"\nequal to the dimensions of the histogram,"
"\nand optionally a weight w for this fill"
"\n(*int* or *float*)."
"\n"
"\nIf Numpy support is enabled, values my also"
"\nbe a 2d-array of shape (m, n), where m is"
"\nthe number of tuples, and optionally"
"\nanother a second 1d-array w of shape (n,).")
.add_property("depth", &histogram::depth) .add_property("depth", &histogram::depth)
.add_property("sum", &histogram::sum) .add_property("sum", &histogram::sum)
.def("value", raw_function(histogram_value)) .def("value", raw_function(histogram_value),
.def("variance", raw_function(histogram_variance)) ":param int args: indices of the bin"
"\n:return: value for the bin")
.def("variance", raw_function(histogram_variance),
":param int args: indices of the bin"
"\n:return: variance estimate for the bin")
.def(self == self) .def(self == self)
.def(self += self) .def(self += self)
.def(self + self) .def(self + self)