~ubuntu-branches/ubuntu/raring/blitz++/raring

« back to all changes in this revision

Viewing changes to doc/blitz.texi

  • Committer: Bazaar Package Importer
  • Author(s): Konstantinos Margaritis
  • Date: 2005-02-28 20:25:01 UTC
  • mfrom: (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050228202501-3i4f2sknnprsqfhz
Tags: 1:0.8-4
Added missing build-depends (Closes: #297323)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
\input texinfo @c -*-texinfo-*-
 
2
@c %**start of header
 
3
@setfilename blitz.info
 
4
@include version.texi
 
5
@settitle Blitz++
 
6
@setchapternewpage odd
 
7
@setcontentsaftertitlepage
 
8
@finalout
 
9
@iftex
 
10
@afourpaper
 
11
@end iftex
 
12
@c %**end of header
 
13
 
 
14
@dircategory Blitz++ library
 
15
@direntry
 
16
* Blitz++: (blitz++).           High-performance C++ numeric library
 
17
@end direntry
 
18
 
 
19
 
 
20
@macro faq{question}
 
21
@strong{@bullet{} \question\}
 
22
@end macro
 
23
 
 
24
@c kludge workaround from Karl Berry for math in @subsection
 
25
@ifnottex
 
26
@macro nabla
 
27
\\nabla
 
28
@end macro
 
29
@macro times
 
30
\\times
 
31
@end macro
 
32
@macro cdot
 
33
\\cdot
 
34
@end macro
 
35
@end ifnottex
 
36
 
 
37
@titlepage
 
38
@title Blitz++ User's Guide
 
39
@subtitle A C++ class library for scientific computing
 
40
@subtitle for version @value{VERSION}, @value{UPDATED}
 
41
@author Todd Veldhuizen
 
42
@page
 
43
@vskip 0pt plus 1filll
 
44
@include copyright.texi
 
45
@end titlepage
 
46
 
 
47
@summarycontents
 
48
@contents
 
49
@page
 
50
 
 
51
@ifnottex
 
52
@node Top, , , (DIR)
 
53
@top Top
 
54
@end ifnottex
 
55
 
 
56
@menu
 
57
* Introduction::                  Introduction
 
58
* Arrays::                        The Array class
 
59
* Array Expressions::             Array Expressions
 
60
* Stencils::                      Stencils
 
61
* Customised Arrays::             Multicomponent, complex, and user type Arrays
 
62
* Indirection::                   Indirect adressing
 
63
* TinyVector::                    The TinyVector class
 
64
* Parallel Computing::            Parallel Computing
 
65
* Random Number Generators::      Random Number Generators
 
66
* Numeric properties::            Numeric properties functions
 
67
* FAQ::                           Frequently Asked Questions, with answers
 
68
* Keyword Index::                 Keyword Index
 
69
* Concept Index::                 Concept Index
 
70
 
 
71
@detailmenu
 
72
 --- The Detailed Node Listing ---
 
73
 
 
74
General considerations
 
75
 
 
76
* about::                         About this document
 
77
* platforms::                     Supported platforms
 
78
* download::                      Where to download Blitz++?
 
79
* install::                       How to install Blitz++?
 
80
* compiling::                     How to compile a program that uses Blitz++?
 
81
* legal::                         License considerations
 
82
* help::                          How to get help?
 
83
 
 
84
The Blitz++ Array class
 
85
 
 
86
* Array intro::                   Getting started
 
87
* Array types::                   Public types declaration for Array
 
88
* Array ctors::                   Array constructors
 
89
* Array slicing::                 How to access the elements of an Array?
 
90
* Slicing combo::                 The slicing machinery
 
91
* Array debug::                   How to debug a program that uses Blitz++?
 
92
* Array members::                 Array member functions
 
93
* Array globals::                 Array global functions
 
94
* Array I/O::                     Inputting and outputting Array's
 
95
* Array storage::                 The storage of Array
 
96
 
 
97
Writing code with the Blitz++ Array class
 
98
 
 
99
* Array expressions::             Creating expressions with Array's
 
100
* Index placeholders::            Array indices functionality
 
101
* Math functions 1::              Single-argument math functions on Array's
 
102
* Math functions 2::              Two-argument math functions on Array's
 
103
* User et::                       Creating your math functions on Array's
 
104
* Where expr::                    The where statement 
 
105
 
 
106
More feaures of the Array class
 
107
 
 
108
* Array multi::                   Multicomponent Array's
 
109
* Array usertype::                Array's of your own type
 
110
@end detailmenu
 
111
@end menu
 
112
 
 
113
@node Introduction
 
114
@chapter Introduction
 
115
@menu
 
116
* about::                         About this document
 
117
* platforms::                     Supported platforms
 
118
* download::                      Where to download Blitz++?
 
119
* install::                       How to install Blitz++?
 
120
* compiling::                     How to compile a program that uses Blitz++
 
121
* legal::                         License considerations
 
122
* help::                          How to get help?
 
123
@end menu
 
124
@include about.texi
 
125
@include platforms.texi
 
126
@include download.texi
 
127
@include install.texi
 
128
@include compiling.texi
 
129
@include legal.texi
 
130
@include help.texi
 
131
    
 
132
@node Arrays
 
133
@chapter Arrays
 
134
@cindex Array
 
135
@findex Array
 
136
@menu
 
137
* Array intro::                   Getting started
 
138
* Array types::                   Public types declaration for Array
 
139
* Array ctors::                   Array constructors
 
140
* Array slicing::                 How to access the elements of an Array?
 
141
* Slicing combo::                 The slicing machinery
 
142
* Array debug::                   How to debug a program that uses Blitz++?
 
143
* Array members::                 Array member functions
 
144
* Array globals::                 Array global functions
 
145
* Array I/O::                     Inputting and outputting Array's
 
146
* Array storage::                 The storage of Array
 
147
@end menu
 
148
@include arrays-intro.texi
 
149
@include arrays-types.texi
 
150
@include arrays-ctors.texi
 
151
@include arrays-slicing.texi
 
152
@include arrays-debug.texi
 
153
@include arrays-members.texi
 
154
@include arrays-globals.texi
 
155
@include arrays-io.texi
 
156
@include arrays-storage.texi
 
157
 
 
158
@node Array Expressions
 
159
@chapter Array Expressions
 
160
@menu
 
161
* Array expressions::             Creating expressions with Array's
 
162
* Index placeholders::            Array indices functionality
 
163
* Math functions 1::              Single-argument math functions on Array's
 
164
* Math functions 2::              Two-argument math functions on Array's
 
165
* User et::                       Creating your math functions on Array's
 
166
* Where expr::                    The where statement
 
167
@end menu
 
168
@include arrays-expr.texi
 
169
 
 
170
@node Stencils
 
171
@chapter Stencils
 
172
@include arrays-stencils.texi
 
173
 
 
174
@node Customised Arrays
 
175
@chapter Multicomponent, complex, and user type arrays
 
176
@menu
 
177
* Array multi::                   Multicomponent Array's
 
178
* Array usertype::                Array's of your own type
 
179
@end menu
 
180
@include arrays-multi.texi
 
181
@include arrays-usertype.texi
 
182
 
 
183
@node Indirection
 
184
@chapter Indirection
 
185
@include arrays-indirect.texi
 
186
 
 
187
@node TinyVector
 
188
@chapter TinyVector
 
189
@include tinyvector.texi
 
190
 
 
191
@node Parallel Computing
 
192
@chapter Parallel Computing with Blitz++
 
193
@include parallel.texi
 
194
 
 
195
@node Random Number Generators
 
196
@chapter Random Number Generators
 
197
@include random.texi
 
198
 
 
199
@node Numeric properties
 
200
@chapter Numeric properties
 
201
@include numinquire.texi
 
202
 
 
203
@node FAQ
 
204
@chapter Frequently Asked Questions
 
205
@include faq.texi
 
206
 
 
207
@node Keyword Index
 
208
@unnumbered Blitz Keyword Index
 
209
@printindex fn
 
210
 
 
211
@node Concept Index
 
212
@unnumbered Concept Index
 
213
@printindex cp
 
214
 
 
215
@c ---------------------------------------------------------------------
 
216
@c Epilogue
 
217
@c ---------------------------------------------------------------------
 
218
 
 
219
@bye