Mercurial > forge

comparison extra/engine/README @ 0:6b33357c7561 octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author pkienzle
date Wed, 10 Oct 2001 19:54:49 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:6b33357c7561
1 liboct.0.1 (alpha version 1e-22) An external interface library for Octave
2
3 Author: Jesse Bennett <jesse@seas.smu.edu>
4
5 What is liboct?
6 ===============
7
8 A buggy, poorly written and undocumented library of C functions which
9 *might* allow *some people* to integrate Octave into their F77/C/C++
10 programs. All I can promise is that it worked for what I needed to do
11 at the time it was written. It is really just a hack which satisfied
12 a need I had.
13
14
15 Warranty
16 ========
17
18 None. Use at your own risk. If it erases your hard drive with all
19 your financial records and your wife's nearly complete dissertation,
20 I'm not responsible. Assume it is unfit for any purpose whatsoever.
21 You have been warned!
22
23
24 License
25 =======
26
27 GPL. If/when it becomes useful I expect to make it LGPL.
28
29
30 Installation
31 ============
32
33 You did read the warranty, right?
34
35 $ cd path/to/where/you/want/it
36 $ cat liboct.0.1.tar.gz | gunzip | tar xvf -
37 $ cd liboct.0.1
38 $ make
39
40 This *might* create liboct.a and a program called mattest, which I
41 used for testing. And then again, it might not.
42
43
44 Bugs
45 ====
46
47 Yes.
48
49
50 NAQ (Never asked questions)
51 ===========================
52
53 Q1. What does mattest do?
54
55 A1. Opens an octave engine, initalizes the matrix "a", then goes into
56 a "pseudo command-line" mode. When either "exit" or "quit" is typed
57 at the command line, the program prints the "a" matrix (which might
58 have been changed), then closes the engine and exits.
59
60 Q2. Without documentation, how can this be useful to anyone?
61
62 A2. It may not be. It was coded from the Matlab V4 "External
63 Interface Guide" and includes the following functions:
64
65 engClose
66 engEvalString
67 engGetFull
68 engOpen
69 engOutputBuffer
70 engPutFull
71 mxCalloc
72 mxFree
73
74 With a few exceptions (e.g. no support for multiple engines or remote
75 execution at this point), things should work as described in the
76 referenced document. To use the functions, include "engine.h" in your
77 source and link with -loct.
78
79 Q3. What can I do to make this useful?
80
81 A3. Offer to fix/improve something. I am putting together a list of
82 TO-DOs. Any offer of help would be appreciated.