[ceph.git] / ceph / src / boost / libs / python / doc / python.qbk

[book Boost.Python
    [quickbook 1.6]
    [authors [Abrahams, David], [Seefeld, Stefan]]
    [copyright 2002 - 2015 David Abrahams, Stefan Seefeld]
    [category inter-language support]
    [id python]
    [purpose
        Reflects C++ classes and functions into Python
    ]
    [license
        Distributed under the Boost Software License, Version 1.0.
        (See accompanying file LICENSE_1_0.txt or copy at
        [@http://www.boost.org/LICENSE_1_0.txt])
    ]
]

[def _boost_      [@http://www.boost.org Boost]]
[def _bb_         [@http://www.boost.org/build Boost.Build]]
[def _bb_list_    [@http://www.boost.org/more/mailing_lists.htm#jamboost Boost.Build mailing list]]
[def _bp_list_    [@http://www.boost.org/more/mailing_lists.htm#cplussig Boost.Python mailing list]]
[def _tutorial_   [@tutorial/index.html Tutorial]]
[def _reference_  [@reference/index.html Reference Manual]]
[def _gsg_        Boost [@http://www.boost.org/more/getting_started/ Getting Started Guide]]
[def _extending_  [@https://docs.python.org/2/extending/extending.html extending]]
[def _embedding_  [@https://docs.python.org/2/extending/embedding.html embedding]]

[h2 Synopsis]

Welcome to Boost.Python, a C++ library which enables seamless interoperability between C++ and the Python programming language. The library includes support for:

* References and Pointers
* Globally Registered Type Coercions
* Automatic Cross-Module Type Conversions
* Efficient Function Overloading
* C++ to Python Exception Translation
* Default Arguments
* Keyword Arguments
* Manipulating Python objects in C++
* Exporting C++ Iterators as Python Iterators
* Documentation Strings

The development of these features was funded in part by grants to `Boost Consulting` from the [@http://www.llnl.gov Lawrence Livermore National Laboratories] and by the [@http://cci.lbl.gov Computational Crystallography Initiative] at Lawrence Berkeley National Laboratories. 

[section Contents]

* _tutorial_
* [link building Building and Testing]
* _reference_
* [link configuration Configuration Information]
* [link glossary Glossary]
* [link support Support Resources]
* [link faq Frequently Asked Questions (FAQs)]
* [@numpy/index.html NumPy Extension Documentation]

[endsect]

[h2 Articles]

[@article.html Building Hybrid Systems With Boost Python], by Dave Abrahams and Ralf W. Grosse-Kunstleve

[include building.qbk]
[include configuration.qbk]
[include support.qbk]
[include faq.qbk]
[include glossary.qbk]
Commit	Line	Data
7c673cae FG	1	[book Boost.Python
	2	[quickbook 1.6]
	3	[authors [Abrahams, David], [Seefeld, Stefan]]
	4	[copyright 2002 - 2015 David Abrahams, Stefan Seefeld]
	5	[category inter-language support]
	6	[id python]
	7	[purpose
	8	Reflects C++ classes and functions into Python
	9	]
	10	[license
	11	Distributed under the Boost Software License, Version 1.0.
	12	(See accompanying file LICENSE_1_0.txt or copy at
	13	[@http://www.boost.org/LICENSE_1_0.txt])
	14	]
	15	]
	16
	17	[def _boost_ [@http://www.boost.org Boost]]
	18	[def _bb_ [@http://www.boost.org/build Boost.Build]]
	19	[def _bb_list_ [@http://www.boost.org/more/mailing_lists.htm#jamboost Boost.Build mailing list]]
	20	[def _bp_list_ [@http://www.boost.org/more/mailing_lists.htm#cplussig Boost.Python mailing list]]
	21	[def _tutorial_ [@tutorial/index.html Tutorial]]
	22	[def _reference_ [@reference/index.html Reference Manual]]
	23	[def _gsg_ Boost [@http://www.boost.org/more/getting_started/ Getting Started Guide]]
	24	[def _extending_ [@https://docs.python.org/2/extending/extending.html extending]]
	25	[def _embedding_ [@https://docs.python.org/2/extending/embedding.html embedding]]
	26
	27	[h2 Synopsis]
	28
	29	Welcome to Boost.Python, a C++ library which enables seamless interoperability between C++ and the Python programming language. The library includes support for:
	30
	31	* References and Pointers
	32	* Globally Registered Type Coercions
	33	* Automatic Cross-Module Type Conversions
	34	* Efficient Function Overloading
	35	* C++ to Python Exception Translation
	36	* Default Arguments
	37	* Keyword Arguments
	38	* Manipulating Python objects in C++
	39	* Exporting C++ Iterators as Python Iterators
	40	* Documentation Strings
	41
	42	The development of these features was funded in part by grants to `Boost Consulting` from the [@http://www.llnl.gov Lawrence Livermore National Laboratories] and by the [@http://cci.lbl.gov Computational Crystallography Initiative] at Lawrence Berkeley National Laboratories.
	43
	44	[section Contents]
	45
	46	* _tutorial_
	47	* [link building Building and Testing]
	48	* _reference_
	49	* [link configuration Configuration Information]
	50	* [link glossary Glossary]
	51	* [link support Support Resources]
	52	* [link faq Frequently Asked Questions (FAQs)]
	53	* [@numpy/index.html NumPy Extension Documentation]
	54
	55	[endsect]
	56
	57	[h2 Articles]
	58
	59	[@article.html Building Hybrid Systems With Boost Python], by Dave Abrahams and Ralf W. Grosse-Kunstleve
	60
	61	[include building.qbk]
	62	[include configuration.qbk]
	63	[include support.qbk]
	64	[include faq.qbk]
65	[include glossary.qbk]