| Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision |
| callable [2019/01/26 11:02] – ↷ Links adapted because of a move operation oroehrig | callable [2019/02/11 21:18] – external edit 127.0.0.1 |
|---|
| ===== Callable Library ===== | ===== Callable Library ===== |
| |
| Starting with release 2.11, polymake offers an alternative interface for integration with other software, a C++ callable library. | polymake offers an alternative interface for integration with other software, a C++ callable library. |
| |
| This page describes only those parts of the interface which are specific to the callable library. Software collaborating with polymake may (and in most cases even have to) use the Object and Function interfaces too; they are described on the [[user_guide:extend:clients|Client Development page]]. | This page describes only those parts of the interface which are specific to the callable library. Software collaborating with polymake may (and in most cases even have to) use the Object and Function interfaces too; they are described on the [[user_guide:extend:clients|Client Development page]]. |
| * ''%%add_extension("DIRECTORY")%%'' loads the extension rooted in the given directory. Repeated calls with the same path have no effect. | * ''%%add_extension("DIRECTORY")%%'' loads the extension rooted in the given directory. Repeated calls with the same path have no effect. |
| * ''newScope()'' create an instance of ''[[callable#scope_class|polymake::perl::Scope]]'' . | * ''newScope()'' create an instance of ''[[callable#scope_class|polymake::perl::Scope]]'' . |
| * ''%%include("RULE_FILE")%%'' parses one additional rule file in the context of the current application. See the corresponding interactive command ''[[:release_docs:latest:core.html#include|include()]]'' . | * ''%%include("RULE_FILE")%%'' parses one additional rule file in the context of the current application. See the corresponding interactive command ''[[reldocs>latest/core.html#include|include()]]'' . |
| * ''%%set_preference("label")%%'' \\ ''%%reset_preference("label")%%'' correspond to the interactive commands of the same names. | * ''%%set_preference("label")%%'' \\ ''%%reset_preference("label")%%'' correspond to the interactive commands of the same names. |
| * ''%%set_custom("name", value)%%'' \\ ''%%reset_custom("name")%%'' allow to change values of custom variables. The variable names must be specified fully qualified (unless they reside in the current application package) and with appropriate leading symbol designating its perl type, that is, ''$'' for scalars, ''@'' for arrays, and ''%'' for hash maps. Note that ''get_custom()'' is now a free function available for [[user_guide:extend:clients#miscellaneous_functions|clients]] too. | * ''%%set_custom("name", value)%%'' \\ ''%%reset_custom("name")%%'' allow to change values of custom variables. The variable names must be specified fully qualified (unless they reside in the current application package) and with appropriate leading symbol designating its perl type, that is, ''$'' for scalars, ''@'' for arrays, and ''%'' for hash maps. Note that ''get_custom()'' is now a free function available for [[user_guide:extend:clients#miscellaneous_functions|clients]] too. |
| |
| For compilation with debugging enabled run ''%%make Debug=y%%'' (see also [[user_guide:extend:clients#building_and_debugging|here]]) and make sure to install with ''%%make install Debug=y%%''. When you run the program you need to set ''POLYMAKE_CLIENT_SUFFIX=-d'' either via ''.gdbinit'' or your environment. | For compilation with debugging enabled run ''%%make Debug=y%%'' (see also [[user_guide:extend:clients#building_and_debugging|here]]) and make sure to install with ''%%make install Debug=y%%''. When you run the program you need to set ''POLYMAKE_CLIENT_SUFFIX=-d'' either via ''.gdbinit'' or your environment. |
| | |