Mercurial > octave-nkf

comparison doc/interpreter/external.txi @ 18534:f51c1498b9f3 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Replace "builtin" with "built-in" for consistency and correctness. * external.txi, func.txi, testfun.txi, doc_cache_create.m: Replace "builtin" with "built-in" for consistency and correctness.
author Rik <rik@octave.org>
date Sat, 01 Mar 2014 22:04:59 -0800
parents 4b32677b6229
children 322eb69e30ad
comparison
equal deleted inserted replaced
18533:ea0d4dea1a17 18534:f51c1498b9f3
1757 @end example 1757 @end example
1758 1758
1759 Note that the application @code{standalone} will be dynamically linked 1759 Note that the application @code{standalone} will be dynamically linked
1760 against the Octave libraries and any Octave support libraries. The above 1760 against the Octave libraries and any Octave support libraries. The above
1761 allows the Octave math libraries to be used by an application. It does 1761 allows the Octave math libraries to be used by an application. It does
1762 not, however, allow the script files, oct-files, or builtin functions of 1762 not, however, allow the script files, oct-files, or built-in functions of
1763 Octave to be used by the application. To do that the Octave interpreter 1763 Octave to be used by the application. To do that the Octave interpreter
1764 needs to be initialized first. An example of how to do this can then be 1764 needs to be initialized first. An example of how to do this can then be
1765 seen in the code 1765 seen in the code
1766 1766
1767 @example 1767 @example
1778 GCD of [10, 15] is 5 1778 GCD of [10, 15] is 5
1779 $ 1779 $
1780 @end group 1780 @end group
1781 @end example 1781 @end example
1782 1782
1783 It is worth noting that, if only builtin functions are to be called from 1783 It is worth noting that, if only built-in functions are to be called from
1784 a C++ standalone program, then it does not need to initialize the 1784 a C++ standalone program, then it does not need to initialize the
1785 interpreter to do so. The general rule is that, for a builtin 1785 interpreter to do so. The general rule is that, for a built-in
1786 function named @code{function_name} in the interpreter, there will be 1786 function named @code{function_name} in the interpreter, there will be
1787 a C++ function named @code{Ffunction_name} (note the prepended capital 1787 a C++ function named @code{Ffunction_name} (note the prepended capital
1788 @code{F}) accessible in the C++ API@. The declarations for all builtin 1788 @code{F}) accessible in the C++ API@. The declarations for all built-in
1789 functions are collected in the header file @code{builtin-defun-decls.h}. 1789 functions are collected in the header file @code{builtin-defun-decls.h}.
1790 This feature should be used with care as the list of built-in functions can 1790 This feature should be used with care as the list of built-in functions can
1791 change. No guarantees can be made that a function that is currently built in 1791 change. No guarantees can be made that a function that is currently built in
1792 won't be implemented as a .m file or as a dynamically linked function in the 1792 won't be implemented as a .m file or as a dynamically linked function in the
1793 future. An example of how to call builtin functions from C++ can be seen in the 1793 future. An example of how to call built-in functions from C++ can be seen in the
1794 code 1794 code
1795 1795
1796 @example 1796 @example
1797 @EXAMPLEFILE(standalonebuiltin.cc) 1797 @EXAMPLEFILE(standalonebuiltin.cc)
1798 @end example 1798 @end example