comparison ROADMAP @ 11482:3c323dde0f85

ROADMAP: Update guide to Octave directory structure.
author Rik <octave@nomad.inbox5.com>
date Mon, 10 Jan 2011 22:01:08 -0800
parents d909c4c14b63
children
comparison
equal deleted inserted replaced
11481:f9241ac19991 11482:3c323dde0f85
1 Here is an attempt at a simple explanation of the directory layout for 1 An overview of the directory layout of Octave's source files:
2 Octave's source files.
3
4 dlfcn -- dlopen, dlsym, dlerror, and dlclose for AIX
5 2
6 doc -- Texinfo documentation for Octave 3 doc -- Texinfo documentation for Octave
7
8 emacs -- Emacs lisp stuff
9 4
10 examples -- some example files 5 examples -- some example files
11 6
12 libcruft -- various numerical libraries (mostly Fortran) 7 libcruft -- various numerical libraries (mostly Fortran)
13 amos * bessel functions 8 amos * bessel functions
14 blas * basic linear algebra subroutines
15 blas-xtra * wrappers for blas functions used in Octave 9 blas-xtra * wrappers for blas functions used in Octave
16 daspk * large scale differential algebraic equation solver 10 daspk * large scale differential algebraic equation solver
17 dasrt * differential algebraic equation solver with root finding 11 dasrt * differential algebraic equation solver with root finding
18 dassl * differential-algebraic system solver 12 dassl * differential-algebraic system solver
19 fftpack * subroutines for fast fourier transforms 13 fftpack * subroutines for fast fourier transforms
20 lapack * linear algebra package
21 lapack-xtra * wrappers for lapack functions used in Octave 14 lapack-xtra * wrappers for lapack functions used in Octave
22 minpack * nonlinear equation solver
23 misc * miscellaneous utilities 15 misc * miscellaneous utilities
24 odepack * odinary differential equation solver 16 odepack * odinary differential equation solver
25 ordered-qz * code for ordering eigenvalues for QZ factorization 17 ordered-qz * code for ordering eigenvalues for QZ factorization
26 quadpack * subroutines for numerical integration 18 quadpack * subroutines for numerical integration
27 ranlib * random number generators 19 ranlib * random number generators
31 liboctave -- the C++ interfaces to the numerical libraries and 23 liboctave -- the C++ interfaces to the numerical libraries and
32 various OS facilities 24 various OS facilities
33 25
34 scripts -- functions written in the Octave language 26 scripts -- functions written in the Octave language
35 audio * play and record sound files (system dependent) 27 audio * play and record sound files (system dependent)
36 control * control theory
37 deprecated * older deprecated functions 28 deprecated * older deprecated functions
38 elfun * elementary mathematical functions 29 elfun * elementary mathematical functions
39 finance * financial functions 30 @ftp * ftp object class
40 general * utility functions 31 general * utility functions
32 geometry * geometry algorithms
41 image * image processing 33 image * image processing
34 help * help subsystem functions
42 io * input/output functions 35 io * input/output functions
43 linear-algebra * linear algebra stuff 36 linear-algebra * linear algebra stuff
44 miscellaneous * stuff that doesn't fit anywhere else 37 miscellaneous * stuff that doesn't fit anywhere else
45 optimization * optimizers 38 optimization * zero finders and minimizers
46 path * functions for path handling 39 path * functions for path manipulation
47 pkg * the package manager 40 pkg * the package manager
48 plot * plotting 41 plot * plotting functions
49 polynomial * polynomial manipulation 42 polynomial * polynomial manipulation
50 quaternion * quaternions
51 set * set manipulation 43 set * set manipulation
52 signal * signal processing 44 signal * signal processing
53 sparse * sparse matrix support 45 sparse * sparse matrix support
54 specfun * special mathematical functions 46 specfun * special mathematical functions
55 special-matrix * functions for generating special types of matrices 47 special-matrix * functions for generating special types of matrices
56 startup * initialization functions 48 startup * initialization functions
57 statistics * statistical stuff 49 statistics * statistical functions, distributions, and tests
58 strings * character string manipulation 50 strings * character string manipulation
59 testfun * unit testing 51 testfun * unit testing
60 time * time and date functions 52 time * time and date functions
61 53
62 src -- the interpreter itself 54 src -- the interpreter itself
63 55
64 test -- tests for the interpreter 56 test -- tests for the interpreter
65 config * configuration files for DejaGnu 57 test_*.m * fixed tests for the interpreter
66 octave.test * subdirectories containing actual tests are here 58 fntests.m * script to run function tests embedded in C++ and .m files
67 59
68 60
69 John W. Eaton 61 John W. Eaton
70 jwe@octave.org 62 jwe@octave.org
71 63
72 Last updated: Wed, 31 Oct 2007 16:44:04 EDT 64 Last updated: Mon Jan 10 21:48:42 PST 2011