User Guide

TM
GAUSS
User Guide
Aptech Systems, Inc. — Mathematical and Statistical System
Information in this document is subject to change without notice and does not represent
a commitment on the part of Aptech Systems, Inc. The software described in this
document is furnished under a license agreement or nondisclosure agreement. The
software may be used or copied only in accordance with the terms of the agreement.
The purchaser may make one copy of the software for backup purposes. No part of
this manual may be reproduced or transmitted in any form or by any means, electronic
or mechanical, including photocopying and recording, for any purpose other than the
purchaser’s personal use without the written permission of Aptech Systems, Inc.
c
Copyright
Aptech Systems, Inc. Maple Valley WA 1984-2006
All Rights Reserved.
GAUSS, GAUSS Engine and GAUSS Light are trademarks of Aptech Systems, Inc.
GEM is a trademark of Digital Research, Inc.
Lotus is a trademark of Lotus Development Corp.
HP LaserJet and HP-GL are trademarks of Hewlett-Packard Corp.
PostScript is a trademark of Adobe Systems Inc.
IBM is a trademark of International Business Machines Corporation
Hercules is a trademark of Hercules Computer Technology, Inc.
GraphiC is a trademark of Scientific Endeavors Corporation
Tektronix is a trademark of Tektronix, Inc.
Windows is a registered trademark of Microsoft Corporation.
Other trademarks are the property of their respective owners.
Part Number: 005496
Version 8.0
Documentation Revision: 852
February 5, 2007
Contents
Contents
1 Introduction
1.1
Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1-1
1.2
Documentation Conventions
. . . . . . . . . . . . . . . . . . . . . . . . . . .
1-2
2.1
Installation Under UNIX/Linux . . . . . . . . . . . . . . . . . . . . . . . . . . .
2-1
2.2
Installation Under Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2-2
2.2.1
Machine Requirements . . . . . . . . . . . . . . . . . . . . . . . . .
2-2
2.2.2
Installation from Download . . . . . . . . . . . . . . . . . . . . . . .
2-2
2.2.3
Installation from CD . . . . . . . . . . . . . . . . . . . . . . . . . . .
2-3
2 Getting Started
3 Using the Command Line Interface
3.1
Viewing Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-2
3.2
Interactive Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-2
3.2.1
quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-2
3.2.2
ed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-3
3.2.3
browse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-3
3.2.4
config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-3
3.3
Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-4
3.3.1
General Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-5
3.3.2
Listing Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-5
3.3.3
Execution Functions . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-5
3.3.4
View Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-6
3.3.5
Breakpoint Commands . . . . . . . . . . . . . . . . . . . . . . . . .
3-7
4 Introduction to the Windows Interface
4.1
GAUSS Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-1
4.1.1
4-2
File Menu
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
iii
GAUSS User Guide
4.1.2
Edit Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-3
4.1.3
View Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-4
4.1.4
Configure Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-5
4.1.5
Run Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-5
4.1.6
Debug Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-6
4.1.7
Tools Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-7
4.1.8
Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-8
4.1.9
Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-9
4.1.10
GAUSS Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-10
4.1.11
Main Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-10
4.1.12
Working Directory Toolbar . . . . . . . . . . . . . . . . . . . . . . . .
4-11
4.1.13
Debug Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-12
4.1.14
Window Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-13
4.1.15
Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-14
4.1.16
GAUSS Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-14
5 Using the Windows Interface
5.1
5.2
5.3
iv
Using the GAUSS Edit Windows . . . . . . . . . . . . . . . . . . . . . . . . .
5-1
5.1.1
Editing Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-2
5.1.2
Using Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-2
5.1.3
Changing the Editor Properties . . . . . . . . . . . . . . . . . . . . .
5-2
5.1.4
Using Keystroke Macros . . . . . . . . . . . . . . . . . . . . . . . . .
5-2
5.1.5
Using Margin Functions . . . . . . . . . . . . . . . . . . . . . . . . .
5-3
5.1.6
Editing with Split Views . . . . . . . . . . . . . . . . . . . . . . . . .
5-3
5.1.7
Finding and Replacing Text . . . . . . . . . . . . . . . . . . . . . . .
5-3
5.1.8
Running Selected Text . . . . . . . . . . . . . . . . . . . . . . . . . .
5-4
Using The Command Input - Output Window . . . . . . . . . . . . . . . . . . .
5-4
5.2.1
Running Commands . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-4
5.2.2
Running Programs in Files . . . . . . . . . . . . . . . . . . . . . . .
5-5
Using Source View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-5
5.3.1
Source Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-6
5.3.2
Symbols Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-6
Contents
5.4
Using the Error Output Window . . . . . . . . . . . . . . . . . . . . . . . . . .
5-7
5.5
Using The Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-7
5.5.1
Starting and Stopping the Debugger . . . . . . . . . . . . . . . . . .
5-7
5.5.2
Using Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-8
5.5.3
Setting and Clearing Breakpoints . . . . . . . . . . . . . . . . . . . .
5-8
5.5.4
Stepping Through a Program . . . . . . . . . . . . . . . . . . . . . .
5-9
5.5.5
Viewing and Editing Variables . . . . . . . . . . . . . . . . . . . . . .
5-9
5.6
5.7
Customizing GAUSS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-10
5.6.1
Preferences Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . .
5-10
5.6.2
Editor Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-14
Using GAUSS Keyboard Assignments . . . . . . . . . . . . . . . . . . . . . .
5-15
5.7.1
Cursor Movement Keys . . . . . . . . . . . . . . . . . . . . . . . . .
5-15
5.7.2
Edit Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-16
5.7.3
Text Selection Keys . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-17
5.7.4
Command Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-17
5.7.5
Function Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-18
5.7.6
Menu Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5-19
6 Matrix Editor
6.1
Using the Matrix Editor
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6-1
6.1.1
Editing Matrices . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6-1
6.1.2
Viewing Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6-2
6.1.3
Matrix Editor Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . .
6-2
7 Library Tool
7.1
Using the Library Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7-1
7.1.1
Managing Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . .
7-1
7.1.2
Managing the Library Index . . . . . . . . . . . . . . . . . . . . . . .
7-2
7.1.3
Managing Library Files . . . . . . . . . . . . . . . . . . . . . . . . .
7-2
v
GAUSS User Guide
8 GAUSS Source Browser
8.1
8.2
Using the Source Browser in TGAUSS . . . . . .
Using the Source Browser in GAUSS . . . . . . .
8.2.1
Opening Files From the Source Browser
8.2.2
Source Browser Keyboard Controls . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
8-1
8-2
8-3
8-3
9 GAUSS Help
9.1
9.2
9.3
9.4
9.5
9.6
Help Menu . . . . . . .
Context-Sensitive Help
SHIFT+F1 Support . . .
CTRL+F1 Support . . .
ToolTips . . . . . . . .
Other Help . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
9-1
9-1
9-2
9-2
9-3
9-3
10.1 Expressions . . . . . . . . . . . . .
10.2 Statements . . . . . . . . . . . . . .
10.2.1 Executable Statements . .
10.2.2 Nonexecutable Statements
10.3 Programs . . . . . . . . . . . . . . .
10.3.1 Main Section . . . . . . . .
10.3.2 Secondary Sections . . . .
10.4 Compiler Directives . . . . . . . . .
10.5 Procedures . . . . . . . . . . . . . .
10.6 Data Types . . . . . . . . . . . . . .
10.6.1 Constants . . . . . . . . .
10.6.2 Matrices . . . . . . . . . .
10.6.3 Sparse Matrices . . . . . .
10.6.4 N-dimensional Arrays . . .
10.6.5 Strings . . . . . . . . . . .
10.6.6 String Arrays . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
10-1
10-2
10-3
10-3
10-4
10-4
10-5
10-5
10-8
10-9
10-9
10-11
10-18
10-19
10-20
10-24
10 Language Fundamentals
vi
Contents
10.6.7
Character Matrices . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-26
10.6.8
Date and Time Formats . . . . . . . . . . . . . . . . . . . . . . . . .
10-27
10.6.9
Special Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-28
10.7 Operator Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-30
10.8 Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-32
10.8.1
Looping
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-32
10.8.2
Conditional Branching . . . . . . . . . . . . . . . . . . . . . . . . . .
10-35
10.8.3
Unconditional Branching
. . . . . . . . . . . . . . . . . . . . . . . .
10-36
10.9 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-37
10.10 Rules of Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-38
10.10.1 Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-38
10.10.2 Case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-38
10.10.3 Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-38
10.10.4 Extraneous Spaces . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-39
10.10.5 Symbol Names
. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-39
10.10.6 Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-39
10.10.7 Assignment Statements . . . . . . . . . . . . . . . . . . . . . . . . .
10-40
10.10.8 Function Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-40
10.10.9 Indexing Matrices . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10-41
10.10.10 Arrays of Matrices and Strings . . . . . . . . . . . . . . . . . . . . .
10-42
10.10.11 Arrays of Procedures . . . . . . . . . . . . . . . . . . . . . . . . . .
10-43
11 Operators
11.1 Element-by-Element Operators . . . . . . . . . . . . . . . . . . . . . . . . . .
11-1
11.2 Matrix Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11-4
11.2.1
Numeric Operators . . . . . . . . . . . . . . . . . . . . . . . . . . .
11.2.2
11-4
Other Matrix Operators . . . . . . . . . . . . . . . . . . . . . . . . .
11-8
11.3 Relational Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11-9
11.4 Logical Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11-13
11.5 Other Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11-16
11.6 Using Dot Operators with Constants . . . . . . . . . . . . . . . . . . . . . . .
11-21
11.7 Operator Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11-22
vii
GAUSS User Guide
12 Procedures and Keywords
12.1 Defining a Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12-2
12.1.1
Procedure Declaration . . . . . . . . . . . . . . . . . . . . . . . . . .
12-3
12.1.2
Local Variable Declarations . . . . . . . . . . . . . . . . . . . . . . .
12-3
12.1.3
Body of Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12-4
12.1.4
Returning from the Procedure . . . . . . . . . . . . . . . . . . . . . .
12-5
12.1.5
End of Procedure Definition . . . . . . . . . . . . . . . . . . . . . . .
12-5
12.2 Calling a Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12-6
12.3 Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12-7
12.3.1
Defining a Keyword . . . . . . . . . . . . . . . . . . . . . . . . . . .
12-7
12.3.2
Calling a Keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12-8
12.4 Passing Procedures to Procedures . . . . . . . . . . . . . . . . . . . . . . . .
12-9
12.5 Indexing Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12-10
12.6 Multiple Returns from Procedures
. . . . . . . . . . . . . . . . . . . . . . . .
12-11
12.7 Saving Compiled Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . .
12-13
13 Sparse Matrices
13.1 Defining Sparse Matrices . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13-1
13.2 Creating and Using Sparse Matrices . . . . . . . . . . . . . . . . . . . . . . .
13-2
13.3 Sparse Support in Matrix Functions and Operators . . . . . . . . . . . . . . .
13-3
13.3.1
Return Types for Dyadic Operators . . . . . . . . . . . . . . . . . . .
13-4
14 N-Dimensional Arrays
14.1 Bracketed Indexing
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14-3
14.2 E×E Conformability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14-5
14.3 Glossary of Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14-5
15 Working with Arrays
15.1 Initializing Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15.1.1
viii
areshape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-1
15-2
Contents
15.1.2
aconcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-4
15.1.3
aeye . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-6
15.1.4
arrayinit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-6
15.1.5
arrayalloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-7
15.2 Assigning to Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-8
15.2.1
index operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-9
15.2.2
getArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-12
15.2.3
getMatrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-13
15.2.4
getMatrix4D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-13
15.2.5
getScalar3D, getScalar4D . . . . . . . . . . . . . . . . . . . . . . . .
15-14
15.2.6
putArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-15
15.2.7
setArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-16
15.3 Looping with Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-17
15.3.1
loopnextindex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-19
15.4 Miscellaneous Array Functions . . . . . . . . . . . . . . . . . . . . . . . . . .
15-21
15.4.1
atranspose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-21
15.4.2
amult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-23
15.4.3
amean, amin, amax . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-25
15.4.4
getDims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-27
15.4.5
getOrders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-27
15.4.6
arraytomat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-28
15.4.7
mattoarray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-28
15.5 Using Arrays with GAUSS functions . . . . . . . . . . . . . . . . . . . . . . .
15-28
15.6 A Panel Data Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-32
15.7 Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15-35
16 Structures
16.1 Basic Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-1
16.1.1
Structure Definition . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-1
16.1.2
Declaring an Instance . . . . . . . . . . . . . . . . . . . . . . . . . .
16-2
16.1.3
Initializing an Instance . . . . . . . . . . . . . . . . . . . . . . . . . .
16-3
16.1.4
Arrays of Structures . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-4
ix
GAUSS User Guide
16.1.5
Structure Indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-5
16.1.6
Saving an Instance to the Disk . . . . . . . . . . . . . . . . . . . . .
16-7
16.1.7
Loading an Instance from the Disk . . . . . . . . . . . . . . . . . . .
16-8
16.1.8
Passing Structures to Procedures
. . . . . . . . . . . . . . . . . . .
16-8
16.2 Structure Pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-9
16.2.1
Creating and Assigning Structure Pointers . . . . . . . . . . . . . . .
16-9
16.2.2
Structure Pointer References . . . . . . . . . . . . . . . . . . . . . .
16-10
16.2.3
Using Structure Pointers in Procedures
. . . . . . . . . . . . . . . .
16-12
16.3 Special Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-14
16.3.1
The DS Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-14
16.3.2
The PV Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-15
16.3.3
Miscellaneous PV Procedures . . . . . . . . . . . . . . . . . . . . .
16-19
16.3.4
Control Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-21
16.4 sqpSolvemt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-22
16.4.1
Input Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-23
16.4.2
Output Argument
. . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-26
16.4.3
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-28
16.4.4
The Command File . . . . . . . . . . . . . . . . . . . . . . . . . . .
16-29
17 Run-Time Library Structures
17.1 The PV Parameter Structure . . . . . . . . . . . . . . . . . . . . . . . . . . .
17-1
17.2 Fast Pack Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17-6
17.3 The DS Data Structure
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17-7
18.1 Autoloader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18-1
18 Libraries
18.1.1
Forward References . . . . . . . . . . . . . . . . . . . . . . . . . . .
18-2
18.1.2
The Autoloader Search Path . . . . . . . . . . . . . . . . . . . . . .
18-3
18.2 Global Declaration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18-9
18.3 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18-12
18.3.1
x
Using .dec Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
18-13
Contents
19 Compiler
19.1 Compiling Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19.1.1
19-2
Compiling a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19-2
19.2 Saving the Current Workspace . . . . . . . . . . . . . . . . . . . . . . . . . .
19-2
19.3 Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19-3
20 File I/O
20.1 ASCII Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-3
20.1.1
Matrix Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-3
20.1.2
General File I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-6
20.2 Data Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-7
20.2.1
Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-7
20.2.2
Creating Data Sets
. . . . . . . . . . . . . . . . . . . . . . . . . . .
20-8
20.2.3
Reading and Writing . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-8
20.2.4
Distinguishing Character and Numeric Data . . . . . . . . . . . . . .
20-9
20.3 GAUSS Data Archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-11
20.3.1
Creating and Writing Variables to GDA’s . . . . . . . . . . . . . . . .
20-11
20.3.2
Reading Variables from GDA’s . . . . . . . . . . . . . . . . . . . . .
20-12
20.3.3
Updating Variables in GDA’s . . . . . . . . . . . . . . . . . . . . . .
20-13
20.4 Matrix Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-13
20.5 File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-14
20.5.1
Small Matrix v89 (Obsolete) . . . . . . . . . . . . . . . . . . . . . . .
20-15
20.5.2
Extended Matrix v89 (Obsolete) . . . . . . . . . . . . . . . . . . . .
20-16
20.5.3
Small String v89 (Obsolete) . . . . . . . . . . . . . . . . . . . . . . .
20-16
20.5.4
Extended String v89 (Obsolete) . . . . . . . . . . . . . . . . . . . . .
20-17
20.5.5
Small Data Set v89 (Obsolete) . . . . . . . . . . . . . . . . . . . . .
20-17
20.5.6
Extended Data Set v89 (Obsolete) . . . . . . . . . . . . . . . . . . .
20-19
20.5.7
Matrix v92 (Obsolete) . . . . . . . . . . . . . . . . . . . . . . . . . .
20-20
20.5.8
String v92 (Obsolete) . . . . . . . . . . . . . . . . . . . . . . . . . .
20-20
20.5.9
Data Set v92 (Obsolete) . . . . . . . . . . . . . . . . . . . . . . . . .
20-21
20.5.10 Matrix v96 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-22
xi
GAUSS User Guide
20.5.11 Data Set v96 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20-23
20.5.12 GAUSS Data Archive . . . . . . . . . . . . . . . . . . . . . . . . . .
20-24
21 Foreign Language Interface
21.1 Writing FLI Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21-2
21.2 Creating Dynamic Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21-3
22 Data Transformations
22.1 Data Loop Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22-2
22.2 Using Other Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22-3
22.3 Debugging Data Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22-3
22.3.1
Translation Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22-3
22.3.2
Compilation Phase
. . . . . . . . . . . . . . . . . . . . . . . . . . .
22-3
22.3.3
Execution Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22-4
22.4 Reserved Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22-4
23 The GAUSS Profiler
23.1 Using the GAUSS Profiler . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23-1
23.1.1
Collection
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23-1
23.1.2
Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23-2
24 Publication Quality Graphics
24.1 General Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24.2 Using Publication Quality Graphics . . . . . . . . . . . . . . . . . . . . . . .
24-1
24-2
24.2.1
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24-2
24.2.2
Graphics Coordinate System . . . . . . . . . . . . . . . . . . . . . .
24-6
24.3 Graphic Panels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24-7
xii
24.3.1
Tiled Graphic Panels
. . . . . . . . . . . . . . . . . . . . . . . . . .
24-7
24.3.2
Overlapping Graphic Panels
. . . . . . . . . . . . . . . . . . . . . .
24-7
24.3.3
Nontransparent Graphic Panels . . . . . . . . . . . . . . . . . . . . .
24-8
Contents
24.3.4
Transparent Graphic Panels . . . . . . . . . . . . . . . . . . . . . . .
24-8
24.3.5
Using Graphic Panel Functions . . . . . . . . . . . . . . . . . . . . .
24-8
24.3.6
Inch Units in Graphic Panels . . . . . . . . . . . . . . . . . . . . . .
24-10
24.3.7
Saving Graphic Panel Configurations . . . . . . . . . . . . . . . . . .
24-10
24.4 Graphics Text Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24-10
24.4.1
Selecting Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24-11
24.4.2
Greek and Mathematical Symbols . . . . . . . . . . . . . . . . . . .
24-12
24.5 Colors
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24-14
24.6 Global Control Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24-14
25 Time and Date
25.1 Time and Date Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25-2
25.2 Time and Date Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25-4
25.2.1
Timed Iterations . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25-6
26.1 Command Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26-1
26.2 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26-3
26.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26-12
26.4 Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26-15
26 ATOG
27 Error Messages
28 Maximizing Performance
28.1 Library System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28-1
28.2 Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28-2
28.3 Memory Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28-3
28.3.1
Hard Disk Maintenance . . . . . . . . . . . . . . . . . . . . . . . . .
28-4
28.3.2
CPU Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28-4
xiii
GAUSS User Guide
A Fonts
A.1
A.2
A.3
A.4
Simplex .
Simgrma
Microb .
Complex
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
A-1
A-1
A-1
A-1
Reading and Setting the Tolerance . . . . . . . . . . . . . . . . . . . . . . . .
Determining Singularity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C-2
C-2
B Reserved Words Appendix
C Singularity Tolerance Appendix
C.1
C.2
29 Command Reference Introduction
29.1
29.2
29.3
29.4
Documentation Conventions . . . . .
Command Components . . . . . . . .
Using This Manual . . . . . . . . . . .
Global Control Variables . . . . . . . .
29.4.1 Changing the Default Values
29.4.2 The Procedure gausset . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
29-2
29-3
29-4
29-5
29-5
29-6
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
30-1
30-20
30-22
30-26
30-27
30-29
30-30
30-39
30-40
30 Commands by Category
30.1
30.2
30.3
30.4
30.5
30.6
30.7
30.8
30.9
xiv
Mathematical Functions . . . .
Finance Functions . . . . . . .
Matrix Manipulation . . . . . .
Sparse Matrix Handling . . . .
N-Dimensional Array Handling
Structures . . . . . . . . . . .
Data Handling (I/0) . . . . . . .
Compiler Control . . . . . . . .
Program Control . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Contents
30.10 OS Functions and File Management
30.11 Workspace Management . . . . . .
30.12 Error Handling and Debugging . . .
30.13 String Handling . . . . . . . . . . . .
30.14 Time and Date Functions . . . . . .
30.15 Console I/O . . . . . . . . . . . . .
30.16 Output Functions . . . . . . . . . . .
30.17 Graphics . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
30-45
30-46
30-47
30-47
30-50
30-52
30-52
30-54
31 Command Reference
D Obsolete Commands
E Colors
Index
xv
List of Figures
List of Figures
4.1
4.2
4.3
4.4
4.5
4.6
6.1
7.1
8.1
16.1
GAUSS Graphical User Interface
Main Toolbar . . . . . . . . . . .
Working Directory Toolbar . . .
Debug Toolbar . . . . . . . . . .
Window Toolbar . . . . . . . . .
Status Bar . . . . . . . . . . . .
Matrix Editor . . . . . . . . . . .
Library Tool . . . . . . . . . . .
Source Browser . . . . . . . . .
Structure tree for e1 . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
4-1
4-10
4-12
4-12
4-13
4-14
6-1
7-1
8-2
16-6
xvii
Introduction
Introduction
1.1
1
Product Overview
TM
GAUSS is a complete analysis environment suitable for performing quick calculations, complex
analysis of millions of data points, or anything in between. Whether you are new to computerized
analysis or a seasoned programmer, the GAUSS family of products combine to offer you an easy
to learn environment that is powerful and versatile enough for virtually any numerical task.
Since its introduction in 1984, GAUSS has been the standard for serious number crunching and
complex modeling of large-scale data. Worldwide acceptance and use in government, industry,
and the academic community is a firm testament to its power and versatility.
The GAUSS System can be described several ways: It is an exceptionally efficient number
cruncher, a comprehensive programming language, and an interactive analysis environment.
GAUSS may be the only numerical tool you will ever need.
1-1
GAUSS User Guide
1.2
Documentation Conventions
The following table describes how text formatting is used to identify GAUSS programming
elements:
Text Style
regular text
Use
narrative
Example
“... text formatting is used ...”
bold text
emphasis
“...not supported under UNIX.”
italic text
variables
“... If vnames is a string or has
fewer elements than x has
columns, it will be ...”
monospace
code example
if scalerr(cm);
cm = inv(x);
endif;
- or filename, path, etc.
“...is located in the examples
subdirectory...”
monospace bold
reference to a GAUSS
command or other
programming element
within a narrative
paragraph
“...as explained under create...”
S C
reference to section
of the manual
“...see O
P, Section 11.7...”
1-2
2.1
2
Installation Under UNIX/Linux
1. Make a directory to install GAUSS in.
2. cd to that directory.
3. Gunzip the .gz file if there is one.
4. Untar the .tar file.
5. Run the executable script ginstall.
6. Put the installation directory in the executable path.
7. Put the installation directory in the shared library search path.
8. Install the license. (To receive a license and license installation instructions, email
supportaptech.com.)
For last-minute information, see README.term.
2-1
Getting
Started
Getting Started
GAUSS User Guide
2.2
2.2.1
Installation Under Windows
Machine Requirements
• A Pentium or AMD computer or equivalent.
• Operating System and Memory (RAM) requirements:
– Windows NT4.0, SP6 IE4.0, 32 MB minimum 256 MB recommended.
– Windows 2000, 64 MB minimum, 256 MB recommended.
– Windows XP, 128 MB minimum, 256 MB recommended.
• Minimum of 100 MB free hard disk space, more may be needed depending on the size of
matrices and the complexity of the program.
• Monthly defragmenting is recommended.
2.2.2
Installation from Download
Downloading
Please note that files can only be downloaded via command line ftp, NOT through a browser
(such as Netscape, Internet Explorer, Firefox, etc.). You must use a command prompt window to
download the files. To open a command prompt window, click on Start, then Run, and type cmd.
Note the directory that you are in; you may need to change to the directory where you wish to save
the files. Use or make a directory for this that has no spaces in the title; there can be problems
saving the files to a directory such as C:\Documents and Settings or C:\Program Files
because of the spaces.
You must know the name of the files you wish to download. To download via command line ftp,
first type the following at a command prompt:
ftp ftp.aptech.com
2-2
Getting Started
Log in as “anonymous” and use your email address as the password.
Then type the following at the ftp prompt to download the files:
Getting
Started
get /outgoing/GAUSS_7.0_Win_32.zip GAUSS_7.0_Win_32.zip
get /outgoing/GAUSS_7.0_Manual.zip GAUSS_7.0_Manual.zip
bye
Installation
Unzip GAUSS_7.0_Win_32.zip in a temporary directory, and run setup.exe.
To receive a license and license installation instructions, email supportaptech.com.
2.2.3
Installation from CD
Insert the GAUSS 7.0 compact disc into the CD-ROM drive, and setup should start automatically.
If setup does not start automatically, click Start, then click Run. Type D:\setup.exe in the dialog
box (where D is the drive letter of the CD-ROM drive).
You can use this procedure for the initial installation of GAUSS, and for additions or
modifications to GAUSS components.
To receive a license and license installation instructions, email supportaptech.com.
2-3
Using the Command Line
Interface
TGAUSS is the command line version of GAUSS. The executable file, tgauss is located in the
GAUSS installation directory.
The format for using TGAUSS is:
tgauss flag(s) program program...
-b
Execute file in batch mode and then exit. You can execute multiple files by
separating file names with spaces.
-l logfile
Set the name of the batch mode log file when using the -b argument. The
default is tmp/gauss.log###, where ### is the process ID.
-e expression Execute a GAUSS expression. This command is not logged when GAUSS is in
batch mode.
-o
Suppress the sign-on banner (output only).
-T
Turn the dataloop translator on.
-t
Turn the dataloop translator off.
3-1
Command
Line
3
GAUSS User Guide
3.1
Viewing Graphics
GAUSS generates .tkf files for graphical output. The default output for graphics is
graphic.tkf. On Windows, you can use vwr.exe to view the graphics file; on
UNIX/Linux/Mac, you can use vwrmp. Two functions are available to convert .tkf files to
PostScript for printing and viewing with external viewers: the tkf2ps function will convert .tkf
files to PostScript (.ps) files, and the tkf2eps function will convert .tkf files to encapsulated
PostScript (.eps) files. For example, to convert the file graphic.tkf to a postscript file named
graphic.ps use:
ret = tkf2ps(‘‘filename.tkf ’’, ‘‘filename.ps’’)
If the function is successful it returns 0.
3.2
3.2.1
Interactive Commands
quit
The quit command will exit TGAUSS.
The format for quit is:
quit
You can also use the system command to exit TGAUSS from either the command line or a
program (see system in the GAUSS L R).
The format for system is:
system
3-2
Using the Command Line Interface
3.2.2
ed
The ed command will open an input file in an external text editor (see ed in the GAUSS L
R).
The format for ed is:
ed filename
browse
The browse command allows you to search for specific symbols in a file and open the file in the
default editor. You can use wildcards to extend search capabilities of the browse command.
The format for browse is:
browse symbol
3.2.4
config
The config command gives you access to the configuration menu allowing you to change the way
GAUSS runs and compiles files.
The format for config is:
config
Run Menu
Translator
Toggles on/off the translation of a file using dataloop. The translator
is not necessary for GAUSS program files not using dataloop.
3-3
Command
Line
3.2.3
GAUSS User Guide
Translator line
number tracking
Toggles on/off execution time line number tracking of the original
file before translation.
Line number
tracking
Toggles on/off the execution time line number tracking. If the
translator is on, the line numbers refer to the translated file.
Compile Menu
3.3
Autoload
Toggles on/off the autoloader.
Autodelete
Toggles on/off autodelete.
GAUSS Library
Toggles on/off the GAUSS library functions.
User Library
Toggles on/off the user library functions.
Declare
Warnings
Toggles on/off the declare warning messages during compiling.
Compiler Trace
Includes the following options:
Off
Turns off the compiler trace function.
File
Traces program file openings and closings.
Line
Traces compilation by line.
Symbol
Creates a report of procedures and the local and
global symbols they reference.
Debugging
The debug command runs a program under the source level debugger.
The format for debug is:
debug filename
3-4
Using the Command Line Interface
3.3.1
General Functions
?
Displays a list of available commands.
q/Esc
Exits the debugger and returns to the GAUSS command line.
+/-
Disables the last command repeat function.
3.3.2
Listing Functions
Displays a specified number of lines of source code in the current file.
lc
Displays source code in the current file starting with the current line.
ll file line
Displays source code in the named file starting with the specified line.
ll file
Displays source code in the named file starting with the first line.
ll line
Displays source code starting with the specified line. File does not change.
ll
Displays the next page of source code.
lp
Displays the previous page of source code.
3.3.3
Command
Line
l number
Execution Functions
s number
Executes the specified number of lines, stepping over procedures.
i number
Executes the specified number of lines, stepping into procedures.
x number
Executes code from the beginning of the program to the specified line count, or
until a breakpoint is hit.
g [[args]]
Executes from the current line to the end of the program, stopping at
breakpoints. The optional arguments specify other stopping points. The syntax
for each optional argument is:
filename line period The debugger will stop every period times it reaches the
specified line in the named file.
3-5
GAUSS User Guide
filename line
The debugger will stop when it reaches the specified line
in the named file.
filename ,, period
The debugger will stop every period times it reaches any
line in the named file.
line period
The debugger will stop every period times it reaches the
specified line in the current file.
filename
The debugger will stop at every line in the named file.
line
The debugger will stop when it reaches the specified line
in the current file.
procedure period
The debugger will stop every period times it reaches the
first line in a called procedure.
procedure
The debugger will stop every time it reaches the first line
in a called procedure.
j [[args]]
Executes code to a specified line, procedure, or period in the file without
stopping at breakpoints. The optional arguments are the same as g, listed above.
jx number
Executes code to the execution count specified (number) without stopping at
breakpoints.
o
Executes the remainder of the current procedure (or to a breakpoint) and stops
at the next line in the calling procedure.
3.3.4
View Commands
v [[vars]]
Searches for (a local variable, then a global variable) and displays the value of a
specified variable.
v$ [[vars]]
Searches for (a local variable, then a global variable) and displays the specified
character matrix.
The display properties of matrices and string arrays can be set using the following commands.
r
3-6
Specifies the number of rows to be shown.
Using the Command Line Interface
c
Specifies the number of columns to be shown.
num,num
Specifies the indices of the upper left corner of the block to be shown.
w
Specifies the width of the columns to be shown.
p
Specifies the precision shown.
f
Specifies the format of the numbers as decimal, scientific, or auto format.
q
Quits the matrix viewer.
Command
Line
3.3.5
Breakpoint Commands
lb
Shows all the breakpoints currently defined.
b [[args]]
Sets a breakpoint in the code. The syntax for each optional argument is:
filename line period The debugger will stop every period times it reaches the
specified line in the named file.
d [[args]]
filename line
The debugger will stop when it reaches the specified line
in the named file.
filename ,, period
The debugger will stop every period times it reaches any
line in the named file.
line period
The debugger will stop every period times it reaches the
specified line in the current file.
filename
The debugger will stop at every line in the named file.
line
The debugger will stop when it reaches the specified line
in the current file.
procedure period
The debugger will stop every period times it reaches the
first line in a called procedure.
procedure
The debugger will stop every time it reaches the first line
in a called procedure.
Removes a previously specified breakpoint. The optional arguments are the
same arguments as b, listed above.
3-7
Introduction to the Windows
Interface
4
Windows
GUI Intro
The GAUSS graphical user interface is a multiple document interface. The interface consists of
the Menu Bar, the Toolbar, edit windows, the Command Input-Output window, and the Status bar
(see Figure 4.1).
“ttfamily “bfseries “upshape LaTeX Error: File ‘iwg1-screen’ not found.ΩΩSee the LaTeX manual or LaTeX C
Figure 4.1: GAUSS Graphical User Interface
4.1
GAUSS Menus
You can view the commands on a menu by either clicking the menu name or pressing ALT+n,
where n is the underlined letter in the menu name. For example, to display the File menu, you can
either click File or press ALT+F.
4-1
GAUSS User Guide
4.1.1
File Menu
The File menu lets you access the file, printer setup, and exit commands. Some of these actions
can also be executed from the toolbar. The File menu contains the following commands:
New
Opens a new, untitled document in an Edit window.
Note: New, unsaved documents are not automatically backed up until you
save them, giving them a file name.
Open
Opens an existing file for viewing or editing.
Reload
Updates the active file.
Save
Saves your changes to the file in the active window. If the file is untitled, you
are prompted for a path and filename.
Save As
Saves your changes to the file in the active window using a new or different
path or file name.
Close
Closes the document in the active window. You are prompted to save the file
if it has been modified since you last saved it.
Close All
Closes all open files. You are prompted to save any file that has been
modified since you last saved it.
Run Program
Runs a GAUSS program file.
Insert File
Opens an existing text file and copies the contents into the active document.
This is similar to pasting text from the Windows clipboard.
Print
Prints the active file or selected text from the active window.
Print Setup
Specifies the printer you want to use. Other printer options, such as page
orientation and paper tray, are also accessed with this command.
Properties
Displays information about the active file.
Change Working
Directory
Changes the directory where GAUSS looks for the files it uses for normal
operation. This command does not affect the Open or Save As paths.
Clear Working
Clears the working directory list.
4-2
Introduction to the Windows Interface
Directory List
Exit
Closes all open files and exits GAUSS. You are prompted to save any file
that has been modified since it was last saved.
Recent Files
GAUSS maintains a list of the ten most recent files you opened, at the end of
the File menu. If the file you want to open is on this list, click it and GAUSS
opens it in an Edit window.
4.1.2
Edit Menu
The Edit menu lets you access the set of editing commands. Some of these actions can also be
executed from the toolbar. The Edit menu contains the following commands:
Restores your last changes in the active window.
Redo
Restores changes in the active window that you removed using the Undo
Edit command.
Cut
Removes selected text from the active window and places it on the Windows
clipboard.
Copy
Copies selected text from the active window to the Windows clipboard.
Paste
Copies text from the Windows clipboard to the active window at the cursor
position.
Select All
Selects all text in the active window.
Clear All
Clears all text in the active window
Find
Finds the specified text in the active window. The search starts at the cursor
position and continues to the end of the text in the active window. The
search can be case sensitive or case insensitive. You may also limit the
search to regular expressions.
Find Again
Resumes the search for the next occurrence of the text you specified in the
previous Find action. Subsequent searches for the same text can also be
performed by pressing F3.
4-3
Windows
GUI Intro
Undo
GAUSS User Guide
Replace
Locates the specified text in the active window and replaces it with the text
you entered in the “Replace with” field in the Search dialog box. The search
starts at the cursor position and continues to the end of the text in the active
window. The search can be case sensitive or case insensitive, and the
replacement can be unique or global.
Insert Time/Date
Inserts the current time and date at the cursor position. GAUSS uses the
time and date that appears in the Microsoft Windows Date/Time Properties
window.
Go To Line
Moves the cursor to the specified line number.
Go To Next
Bookmark
Moves to the next bookmark in the program.
Toggle
Bookmark
Sets or clears existing bookmarks from the program.
Edit Bookmarks
Opens the Edit Bookmarks window. From the Edit Bookmarks window you
can add, remove, or go to any set bookmark in a program.
Record Macro
Places a series of keystrokes into memory so that they can be called at a later
date. For more information about recording macros see U K
M, Section 5.1.4.
Clear Macros
Clears macros from memory.
4.1.3
View Menu
The View menu lets you toggle the Main Toolbar, the Status Bar, the Working Directory Toolbar,
and the Debug Toolbar on or off.
Main Toolbar
Toggles the Main toolbar on or off. For more information about the Main
toolbar, see M T, Section 4.1.11.
Status Bar
The Status Bar is located along the bottom of the GAUSS window. For more
information about the status bar, see S B, Section 4.1.15.
Working
Toggles the Working Directory toolbar on or off. For more information
4-4
Introduction to the Windows Interface
Directory
about the working directory toolbar, see W D T,
Section 4.1.12.
Debug Toolbar
Toggles the Debug toolbar on or off. For more information about the Debug
toolbar, see D T, Section 4.1.13.
Window Toolbar
Toggles the Window toolbar on or off. For more information about the
Window toolbar, see W T, Section 4.1.14.
Error Output
Opens or closes the Error Output window.
Source View
Displays or undisplays the Source/Symbols window.
4.1.4
Configure Menu
The Configure menu lets you customize the GAUSS environment.
Opens the General Preferences window. From the General Preferences
window you can define Run options, Compile options, DOS window
options, and Autosave options. For more information on configuring
GAUSS General Preferences, see P D B, Section 5.6.1.
Editor
Properties
Opens the Editor Properties window. From the Editor Properties window
you can define colors and fonts, the language syntax, tabs, or general editor
properties. For more information on configuring editor properties, see
E P, Section 5.6.2.
4.1.5
Run Menu
The Run menu lets you run the code you have entered, a block of code you selected, or the active
file, depending on the operating mode.
Insert GAUSS
Prompt
Manually adds the GAUSS prompt (>>) at the cursor position. The GAUSS
prompt is automatically displayed following the execution of GAUSS code.
4-5
Windows
GUI Intro
Preferences
GAUSS User Guide
Insert Last Cmd
Re-enters the last command written to the Input buffer.
Run Selected
Text
Runs any text selected from the editor or the Command Input-Output
window.
Run Active File
Runs the active file. The file then becomes the main file.
Test Compile
Active File
Compiles the currently selected file. During compilation, any errors are
displayed in the Output window.
Note: This command is different than the GAUSS compile command, which
compiles a program and saves the pseudocode as a file.
Run Main File
Runs the file specified in the Main File list.
Test Compile
Main File
Test compiles the main file. During compilation, any errors are displayed in
the Output window.
Note: This command is different than the GAUSS compile command, which
compiles a program and saves the pseudocode as a file.
Edit Main File
Opens the specified main file in an edit window.
Stop Program
Stops the program currently running and returns control to the editor.
Build GCG File
from Main
Creates GAUSS pseudocode file that can be run over and over with no
compile time.
Set Main File
Makes the active file the main file.
Clear Main
File List
Removes all entries in the Main File list on the Main toolbar.
Translate
Dataloop Cmds
Toggles translate dataloop command on and off. For more information see
D T, Chapter 22.
4.1.6
Debug Menu
The Debug menu lets you access the commands used to debug your active file or main file.
The Debug menu contains the following Commands:
4-6
Introduction to the Windows Interface
Runs the main file in the debugger.
Debug Active
File
Runs the active file in the debugger.
Set/Clear
Breakpoint
Enables or disables a breakpoint at the cursor in the active file.
Edit
Breakpoints
Opens a list of all breakpoints in your program. The breakpoints are listed
by line number. Any procedure breakpoints are also listed.
Clear All
Breakpoints
Removes all line and procedure breakpoints from the active file.
Go
Starts the debugger.
Stop
Stops the debugger.
Run to Cursor
Runs the program until it reaches the cursor position.
Step Into
Runs the next executable line of code in the application and steps into
procedures.
Step Over
Runs the next executable line of code in the application but does not step
into procedures.
Step Out
Runs the remainder of the current procedure and stops at the next line in the
calling procedure. Step Out returns if a breakpoint is encountered.
Set Watch
Opens the Matrix Editor for watching changing variable data. For more
information about viewing variables see V V, Section 5.5.5.
4.1.7
Windows
GUI Intro
Debug Main File
Tools Menu
The Tools menu lets you open GAUSS tools windows. The following commands can be used:
Matrix Editor
Lets you create or edit data in a matrix (or grid). A cell can be edited by
typing in a new value and pressing ENTER. For more information see
M E, Chapter 6.
4-7
GAUSS User Guide
Graphics Editor
Opens the Graphics Editor, which is an interactive TKF file editor. This
menu item will be inactive if you have not purchased the Graphics Editor.
Source Browser
Searches source files for string patterns. For more information see GAUSS
S B, Chapter 8.
Lib Tool
Lets you manage the contents of libraries. For more information see L
T, Chapter 7.
DOS
Compatibility
Window
Opens a DOS Compatibility window.
4.1.8
Window Menu
The Window menu commands let you manage your workspace. You can toggle the focus between
all open windows using CTRL+TAB, or clicking in the window you want active. All open
windows are listed at the end of the Window menu. The following commands can be used:
Cmd Window
Makes the Command Input - Output window the active window.
Output Window
Splits the output from the Command Input - Output window.
Debug Window
Starts the debugger on the current file.
Re-use Window
If checked, the next file browsed in the Source Browser will be displayed in
the same window.
Command Log
Loads the command log window into an editor.
Close All
Graphics
Closes all TKF File Viewer windows.
Dual Horizontal
Horizontally tiles the program source and execution windows within the
main window, and minimizes all other windows.
Dual Vertical
Vertically tiles the program source and execution windows within the main
window, and minimizes all other windows.
4-8
Introduction to the Windows Interface
Cascade
Arranges all open windows on the screen, overlapping each, with the active
window on top.
Tile Horizontal
Arranges all open windows horizontally on the screen without any overlap.
Tile Vertical
Arranges all open windows vertically on the screen without any overlap.
Arrange Icons
Arranges all minimized windows across the bottom of the main GAUSS
window.
Split
Horizontally
Splits the active window into two horizontal panes. This allows you to view
two different areas of the same document to facilitate split-window editing.
Note: You can move the splitter bar by dragging it with the mouse. You can
remove the splitter bar from the window by dragging it to the end of the
window.
Split Vertically
Splits the active window into two vertical panes. This allows you to view
two different areas of the same document to facilitate split-window editing.
Open Window
List
4.1.9
GAUSS maintains a list of all the windows you have opened at the end of
the Window menu. If the window you want to view is on this list, click it and
it becomes the active window.
Help Menu
The Help menu lets you access information in the GAUSS Help system. The GAUSS Help menu
contains the following Commands:
User’s Guide
Accesses the online GAUSS U’ G.
Keyboard
Accesses the list of keystrokes you can use for cursor movement, editing,
and text selection.
Reference
Accesses the online GAUSS L R, which contains the syntax
for each GAUSS command.
4-9
Windows
GUI Intro
Note: You can move the splitter bar by dragging it with the mouse. You can
remove the splitter bar from the window by dragging it to the end of the
window.
GAUSS User Guide
Tip of the Day
Displays a tip to help you make better use of the features available in the
GAUSS Windows Interface.
About GAUSS...
Provides information about your version of GAUSS, your license type and
ID, as well as copyright information.
4.1.10
GAUSS Toolbars
The toolbar buttons let you have fast access to the most commonly used commands. Place the
mouse pointer over the button to display a description of the command.
4.1.11
Main Toolbar
“ttfamily “bfseries “upshape LaTeX Error: File ‘iwg2-maintool’ not found.ΩΩSee the LaTeX manual or LaTeX
Figure 4.2: Main Toolbar
New
Opens a new, untitled document in an Edit window.
Note: New, unsaved documents are not automatically backed up until you
save them, giving them a file name.
Open
Opens an existing file for viewing or editing.
Save
Saves your changes to the file in the active window. If the file is untitled, you
are prompted for a path and filename.
Cut
Removes selected text from the active window and places it on the Windows
clipboard.
Copy
Copies selected text from the active window to the Windows clipboard.
Paste
Copies text from the Windows clipboard to the active window at the cursor
position.
Print
Prints the active file or selected text from the active window.
4-10
Introduction to the Windows Interface
Accesses the GAUSS help system.
Source
Browser
Opens the GAUSS Source Browser, which allows you to search for
symbols in a specified file or directory. For more information, see GAUSS
S B, Chapter 8.
Graphics Editor
Opens the Graphics Editor, which is an interactive TKF file editor. This
menu item will be inactive if you have not purchased the Graphics Editor.
Run Selected
Text
Runs any text selected from the editor or the Command Input-Output
window.
Run Active
File
Runs the active file. The file then becomes the main file.
Main File
List
Displays the name of the main file and lets you quickly change the main file
to one of the files listed.
Run Main
File
Runs the file specified in the Main File list.
Stop Program
Stops the program currently running and returns control to the editor.
Test Compile
Main File
Compiles the main file. During compilation, any errors are displayed in the
Output window.
Note: This command is different than the GAUSS compile command, which
compiles a program and saves the pseudocode as a file.
Edit Main
File
Opens the specified main file in an edit window.
Debug Main
File
Runs the main file in the debugger.
4.1.12
Working Directory Toolbar
You can use the Working Directory toolbar to quickly change your working directory.
Current
Working
Displays the name of the current working directory and lets you quickly
change the working directory to one of the directories listed.
4-11
Windows
GUI Intro
Help
GAUSS User Guide
“ttfamily “bfseries “upshape LaTeX Error: File ‘iwg3-workdir’ not found.ΩΩSee the LaTeX manual or LaTeX
Figure 4.3: Working Directory Toolbar
Directory List
Change
Working
Directory
4.1.13
Browses to a new directory.
Debug Toolbar
You can use the Debug toolbar for quick access to commands while debugging a file.
“ttfamily “bfseries “upshape LaTeX Error: File ‘iwg4-debug’ not found.ΩΩSee the LaTeX manual or LaTeX C
Figure 4.4: Debug Toolbar
Go
Starts the debugger.
Stop
Stops the debugger.
Toggle
Breakpoint
Enables or disables a breakpoint at the cursor in the active file.
Clear All
Breakpoints
Removes all line and procedure breakpoints from the active file.
Set Watch
Opens the Matrix Editor for watching changing variable data. For more
information about viewing variables see V V, Section 5.5.5.
Step Into
Runs the next executable line of code in the application and steps into
procedures.
Step Over
Runs the next executable line of code in the application but does not step
into procedures.
4-12
Introduction to the Windows Interface
Step Out
Runs the remainder of the current procedure and stops at the next line in the
calling procedure. Step Out returns if a breakpoint is encountered.
Run to Cursor
Runs the program until it reaches the cursor position.
4.1.14
Window Toolbar
You can use the Window toolbar for quick access to window commands.
“ttfamily “bfseries “upshape LaTeX Error: File ‘wintool’ not found.ΩΩSee the LaTeX manual or LaTeX Comp
Figure 4.5: Window Toolbar
Makes the Command window the active window.
Activate/
Deactivate
Output Window
Splits the output from the Command Input-Output window, or deactivates
Output window.
Activate Debug
Window
Makes the Debug window the active window.
Source/Symbol
View
Displays or undisplays the Source/Symbol window.
Error Output
Window
Opens or closes the Error Output window.
Tile windows
horizontally
Tiles the active window and the Output or Command Input - Output
window horizontally.
Tile windows
vertically
Tiles the active window and the Output or Command Input - Output
window vertically.
Src Browser
replaces window
with new file
contents
If selected, the next file browsed in the Source Browser will be displayed
in the same window.
4-13
Windows
GUI Intro
Activate Cmd
Window
GAUSS User Guide
4.1.15
Status Bar
The status bar is located along the bottom of the GAUSS window. The status of the windows and
processes are shown on the status bar.
4.1.16
GAUSS Status
The first section of the status bar shows the current GAUSS status. From time to time you are
alerted to the task GAUSS is performing by new messages appearing in the status bar.
“ttfamily “bfseries “upshape LaTeX Error: File ‘iwg5-status’ not found.ΩΩSee the LaTeX manual or LaTeX C
Figure 4.6: Status Bar
Cursor Location
The line number and column number where the cursor is located appear on
the status bar for the active window. When a block of text is selected, the
values indicate the first position of the selected text.
DATALOOP
DATALOOP appears on the status bar to indicate the Dataloop Tranlator is
turned on.
OVR
OVR appears on the status bar when typing replaces the existing text with
text you enter. When OVR does not appear on the status bar, typing inserts
text without deleting the existing text. Press the INSERT key to toggle
between the two conditions.
CAP
CAP appears on the status bar to indicate the Caps Lock key has been
pressed and all text you enter will appear in upper case.
NUM
NUM appears on the status bar to indicate the Num Lock key has been
pressed and the keypad numbers are active.
4-14
Using the Windows Interface
5
5.1
Using the GAUSS Edit Windows
The GAUSS edit windows provide syntax color coding and auto-formatting as well as easy access
to the Matrix Editor and Library Tool, and include an integrated context-sensitive help system
accessible through the F1 key.
The edit windows provide standard text editing features like drag and drop text editing, and find
and replace. The editor also lets you set bookmarks, define keystroke macros, find and replace
using regular expressions, and run selected text from the editor.
5-1
Windows GUI
The GAUSS graphical user interface is a multiple document interface. The interface consists of
edit windows and the Command Input - Output window. Integrated into GAUSS is a full debugger
with breakpoints and watch variables. The GAUSS graphical user interface also incorporates the
Matrix Editor (see Chapter 6), Library Tool (see Chapter 7), and GAUSS Source Browser (see
Chapter 8), as well as a context-sensitive HTML Help system (see Chapter 9).
GAUSS User Guide
5.1.1
Editing Programs
To begin editing, open an edit window by browsing to the source file, or by typing edit and the
filename in the Command Input - Output window. If more than one file is open, the last file opened
or run becomes the active window.
5.1.2
Using Bookmarks
Bookmarks are efficient placeholders used to identify particular sections or lines of code. To add
or remove bookmarks, place the cursor in the line you want to bookmark and then press
CTRL+F2, or click Toggle Bookmark on the Edit menu. You can jump to the next bookmark by
pressing F2, or go to the previous bookmark by pressing SHIFT+F2.
To edit a list of all currently defined bookmarks, click Edit Bookmarks on the Edit menu. The Edit
Bookmarks window allows you to add, remove, name or select the bookmark to which you wish to
jump.
5.1.3
Changing the Editor Properties
You can customize the formatting of your code and text by changing font colors, fonts, adding line
indentations, and adding line numbering to your programs. To access these properties, on the
Configure menu click Editor Properties, or right-click on an edit window and click Properties on
the context menu.For more information about the Editor Properties see E P, Section
5.6.2.
5.1.4
Using Keystroke Macros
GAUSS will save up to 10 separate keystroke macros.
To record a keystroke macro, press CTRL+SHIFT+R, or click Record Macro on the Edit menu.
When you start recording the macro, a stop button will appear in the GAUSS window.
5-2
Using the Windows Interface
You create a macro by clicking Record Macro and pressing the keystrokes you want recorded.
Once you have completed recording the macro, you can stop recording with the stop button. Once
you have finished recording the macro, you can select one of ten macro names for it.
Use the following guidelines when creating and using your macro:
• Only keystrokes in the active window are recorded, not keystrokes in a dialog box.
• Only keystrokes are recorded, not mouse movements.
Macros are not saved when you close GAUSS.
If your macro is lengthy, consider creating a separate file and copying the information from the file
into the active window, rather than using a macro to enter the information.
5.1.5
Using Margin Functions
The margin of the edit window can be used to show currently set bookmarks, currently set
breakpoints, and line numbers. You can also select an entire line of text with a single click in the
Selection Margin.
You can turn on or off the margin in the Misc tab of the Editor Properties dialog box.
Editing with Split Views
Using split views, you can edit two parts of the same program in the same buffer. To open split
views, click Split Horizontally or Split Vertically on the Window menu.
5.1.7
Finding and Replacing Text
Along with a standard find and replace function, you can use the edit window to find and replace
regular expressions. To find regular expressions, open the Find dialog box and select the checkbox
for regular expressions.
5-3
Windows GUI
5.1.6
GAUSS User Guide
5.1.8
Running Selected Text
There are three ways you can run selected text. First, highlight the text you want to run, then either
press CTRL+R, drag and drop the selected text into the Command Input - Output window, or click
“Run Selected Text” on the Run menu.
5.2
Using The Command Input - Output Window
The Command Input - Output window lets you input interactive commands and view the results.
The Command Input - Output window can be split into two separate windows, one for input and
one for output, by clicking Output Window on the Window menu.
Output will be written at the insertion point in the Command Input - Output window or the Output
window, when it is a separate window. GAUSS commands cannot be executed from this window.
From the Command Input - Output window, you can run saved programs. You can view or edit the
data of any variable in the active workspace with the Matrix Editor. You can also open files for
editing or to debug.
The GAUSS Command Input - Output window has many of the same features that the GAUSS text
editor has. You can cut and paste text. You can search the buffer of the Command Input - Output
window. You can also save the contents of the Command Input - Output window to a text file.
5.2.1
Running Commands
The GAUSS interface allows you to run programs that consist of single commands or blocks of
commands executed interactively, as well as large-scale programs that may consist of commands
in one or more files. The file that is run to execute the command is the main file (the file name
displayed in the Main File list).
When you run commands interactively, the actual code being processed is called the “active
block.” The active block is all code between the GAUSS prompt (>>) and the end of the current
line. Thus, the active block can be one or more lines of code.
5-4
Using the Windows Interface
Interactive commands can be entered at the “>>” prompt in the Command Input - Output window
or selected using the mouse and clicking the Run Selected Text button on the Main toolbar.
A block of code can be executed by selecting the block with the mouse and then running that
block using the Run Selected Text function.
Note: The GAUSS prompt (>>) at the beginning of the selected text is ignored.
You can enter multi-line commands into the Command Input - Output window by pressing
CTRL+ENTER at the end of each line. At the end of the final line in a multi-line command, press
ENTER. The Command Input - Output window will automatically place a semicolon at the end of
a single-line command before it is interpreted. For multi-line commands, you must enter a
semicolon at the end of each line.
You can also run multi-line commands by pasting the text of a file at the GAUSS prompt, or
selecting multiple lines of code from the Command Input - Output window and pressing CTRL+R.
You can repeat any of the last 20 lines entered into the command buffer by pressing CTRL+L to
cycle through the last command buffer.
5.2.2
Running Programs in Files
You can execute the file displayed in the Main File list (the main file) by clicking Run Main file on
the Run menu, or by clicking the Run Main File button on the Main toolbar.
5.3
Using Source View
Source View is a dockable dialog bar with two tabs that provide easy access to source files and
symbols associated with your current GAUSS workspace.
5-5
Windows GUI
You can execute the active file by clicking Run Active File on the Run menu, or by clicking the
Run Currently Active File button on the Main toolbar.
GAUSS User Guide
5.3.1
Source Tab
The Source tab is a tree view that displays a list of active libraries and the source files they contain.
Under each source file is a list of the symbols and procedures which they define. By using the
right mouse button, you can search for symbols, open source files or view source file properties.
Opening a Source File
To open a source file, double click the file name or right click the file and click Edit.
Finding Commands in Source Files
To search the source files right click any file name in the source tab and click Find. In the Find
dialog enter a keyword and click OK.
5.3.2
Symbols Tab
The Symbols tab contains a tree view of the GAUSS workspace global symbols organized by
symbol type: Matrices, Arrays, Strings, String Arrays, and Structures.
Editing or Viewing a Symbol
To edit or view a symbol, double-clicking on it or right-clicking and selecting Edit from the menu.
Finding Symbols in Source Files
To search the source files right click any file name in the source tab and click Find. In the Find
dialog enter a keyword and click OK.
5-6
Using the Windows Interface
5.4
Using the Error Output Window
The Error Output window allows errors messages to be output to a separate window, instead of the
GAUSS Input - Output window. When an error occurrs, you can open to program of source file
directly from the Error Output window.
To open the program or source file, press F4 or double click the error message. The file will open
at the line the error occurred.
5.5
Using The Debugger
The debugger greatly simplifies program development. With all of the features of a dedicated
debugging system, the debugger can help you to quickly identify and solve logic errors at run-time.
The debugger is integrated into the multiple document interface of GAUSS; it uses the interface
tools, such as the edit windows, the Matrix Editor, and the Command Input - Output window for
debugging. So while using the debugger, you still have all the features of the edit windows and
Matrix Editor, along with GAUSS’s suite of debugging tools.
You use the debugger to watch the program code as it runs. Prior to running the debugger,
breakpoints and watch variables can be set to stop the program at points you set and provide
additional data as the code is run.
Windows GUI
5.5.1
Starting and Stopping the Debugger
You can start the debugger by clicking Go on the Debug menu or the Debug toolbar.
When starting the debugger, you can choose to debug the active file or to debug the main file of a
program. If you are debugging a single file and already have the file open, you can use the menu or
toolbar to start the debugger on the file, or simply type debug and the filename in the Command
Input - Output window.
When you start the debugger, the debugger automatically highlights the first line of code to be run.
Any breakpoints are shown in the left margin of the window.
5-7
GAUSS User Guide
You can stop the debugger at any time by clicking Stop on the Debug menu or the Debug toolbar.
5.5.2
Using Breakpoints
Breakpoints stop code execution where you have inserted them. Breakpoints are normally set prior
to running the debugger, but can also be set or cleared during debugging by clicking the Set/Clear
Breakpoint command on the Debug menu.
The debugger supports two types of breakpoints: procedure breakpoints and line number
breakpoints. Procedure breakpoints pause execution when the specified procedure or function is
reached. Line number breakpoints pause execution when the specified line is reached. In either
case, the break occurs before any of the GAUSS code for the procedure or line is executed. The
debugger also allows you to specify a certain cycle of execution for a line number or procedure
where you want the execution to be paused. The cycle count is for the occurrence of the line
number or procedure, not the number of times a line is to be skipped.
5.5.3
Setting and Clearing Breakpoints
You can set or clear a line breakpoint in the highlighted line of code by clicking Set/Clear
Breakpoint on the Debug menu or by pressing the F9 key.
To set breakpoints in any part of the file not currently being executed, just click the line where you
want the breakpoint to be, then click Toggle Breakpoint.
To clear breakpoints in the file, click a line of code that has a breakpoint set and then click
Set/Clear Breakpoint. You can also clear all breakpoints from the active file by clicking Clear All
Breakpoints.
Using the Breakpoint Editor to Set and Clear Breakpoints
The Breakpoint Editor allows you to set or clear both line and procedure breakpoints. It also lets
you specify cycles of execution for breakpoints. With the Breakpoint Editor, you can set or clear
breakpoints in any program currently in your working directory.
5-8
Using the Windows Interface
5.5.4
Stepping Through a Program
GAUSS’s debugger includes the ability to step into, step out of, and step over code during
debugging.
Use Step Into to execute the line of code currently highlighted by the debugger.
Use Step Out to execute to the end of the current function without pause and return to the calling
function.
Use Step Over to execute the line of code currently highlighted by the debugger without entering
the functions that are called.
5.5.5
Viewing and Editing Variables
GAUSS allows you to view and edit the values of variables during debugging.
Viewing Variable Values During Debugging
The floatover variable window is only intended to give a quick view of the data, so it may not
show all data held by the variable. If the variable data is incomplete, the floatover variable window
will display an arrow to show that there is more data. If you need to view more data, open the
Matrix Editor by highlighting the variable name and pressing CTRL+E.
Editing Variable Values During Debugging
The debugger integrates the Matrix Editor to edit values of loaded variables, or to use as a watch
window to view the changing values of variables as you step through a program.
5-9
Windows GUI
Once the debugger is started, the editor window uses floatover variable windows for viewing
variable data. Floatover variable windows give a quick view of the value a variable currently holds
by simply moving your mouse over the variable name in the edit window.
GAUSS User Guide
To edit a variable value, highlight the variable in the edit window, or the Command Input - Output
window and then open the Matrix Editor. You can use the menu or toolbar to start the Matrix
Editor, or simply type CTRL+E.
Making a Watch Window
You can make the Matrix Editor a Watch window, allowing you to watch the changing value of a
variable as the lines of the program are executed. You can activate the Watch window by clicking
Set Watch on the Debug menu, or by highlighting a variable name in the debugger window and
pressing CTRL+E.
You use a Watch window to see how variables change in value during debugging. Watch variables
can be specified prior to running the debugger or during a debugging session.
The debugger searches for a watch variable using the following order:
1. A local variable within a currently active procedure.
2. A global variable.
A watch variable can be the name of a matrix, a scalar, a string array, or a string. For a matrix or a
string array, the first element is displayed. If a matrix element is clicked, the Matrix Editor is
loaded with the matrix. The matrix elements can be changed during the debugging session.
5.6
5.6.1
Customizing GAUSS
Preferences Dialog Box
The Preferences dialog box lets you specify how GAUSS operates. To open the Preferences dialog
box, click Preferences... on the Configure menu. The changes you make in the Preferences dialog
box remain set between sessions.
5-10
Using the Windows Interface
Run Options
Dataloop
Translator
Specifies whether or not GAUSS will translate data loops into
procedures.
Translate Line
Number
Tracking
Specifies whether or not GAUSS will preserve the line numbers of data
loops after being translated to procedures.
Line Number
Tracking
Specifies whether or not GAUSS will preserve line numbers of a file
being compiled for the interpreter.
Sound at End
of Job
Determines whether or not a sound is played at the end of the execution
of GAUSS code. The sound can be selected using the Select button
and played using the Test button.
The default is OFF.
Compile Options
The Compile tab contains options that let you control how GAUSS compiles a program before it is
run.
Specifies whether the autoloader will automatically resolve references
in your code. If Autoload is off, you must define all symbols used in
your program.
Autodelete
Use Autodelete in conjunction with Autoload to control the handling of
references to unknown symbols.
GAUSS Library
Specifies whether the autoloader will use the standard GAUSS library
in compiling your code.
User Library
Specifies whether the autoloader will use the User Libraries in
compiling your code.
Declare
Specifies whether the GAUSS compiler will display declare warnings
5-11
Windows GUI
Autoload
GAUSS User Guide
Warnings
in the Command Input - Output window. For more information on
declare warnings see U . F, Section 18.3.1.
Compiler Trace
Specifies whether you would like to trace the file compilation by file
opening and closing, specific lines, or whether you would like to trace
by local and global symbols.
Cmd Window
The Cmd Window tab contains options that let you control how the GAUSS Command Window
operates.
Action on
Enter
Specifies whether pressing ENTER executes the current whole line
always or only when the cursor is at the end of a line. Also, specifies
whether placing a semi-colon at the end of a line causes GAUSS to
enter multi-line mode.
Performance
Specifies whether or not output is buffered, and sets the buffer size in
kilobytes.
Cmd Prompt
Specifies whether new GAUSS prompts are inserted at the current
cursor location, appended to the text in the Command window, or
relocated on the line following the cursor.
Output
Specifies whether output from a GAUSS program is inserted at the
current cursor location, appended to the text in the Command window,
or written over the text following the cursor.
DOS Compatibility
The DOS Compatibility tab lets you control the appearance of the DOS Compatibility window.
5-12
Change Font
Specifies what font the DOS Compatibility window will use.
Tab size
Specifies the tab size in a DOS Compatibility window
Using the Windows Interface
Stay on top of
GAUSS
Specifies whether the DOS Compatibility window will stay on top of
GAUSS.
File
The File tab contains options that let you control how GAUSS auto-saves your work.
Save file on
Execute
Specifies whether open files will
automatically be saved when a file is run. If the file you are running is
loaded, it will be saved prior to execution, regardless of how it is
executed (Run file, command line, main file, or active file). All open
editor files, including the active file, are saved before execution.
Note: New, unsaved documents are not automatically backed up until
you save them, giving them a file name. After you save the new file, it
will be automatically backed up with all other open files.
Autosave
Specifies whether you want GAUSS to automatically save your files at
a set interval of time.
Edit Window
Properties
Specifies the initial window size of opened
files.
Misc
Windows GUI
The Misc tab contains several general options to control GAUSS.
Show Tip of the
Day at startup
Turns on/off the Tip of the Day at startup.
Keep Help
Window On Top
of GAUSS
Specifies whether the Help window always stays on top of GAUSS
when opened.
Set Initial
Window Position
Specifies initial position of the Help
window.
Graphics Editor
License
If you have purchased the Graphics Editor,
this is where you will enter or change the Graphics Editor license key.
5-13
GAUSS User Guide
5.6.2
Editor Properties
You can customize the formatting of your code and text by changing font colors, fonts, adding line
indentations, and adding line numbering to your programs. To access these properties, on the
Configure menu click Editor Properties.
Color/Font
Color
Specifies the way syntax coloring works in the editor.
Font
Specifies what font the edit window will use.
Language/Tabs
Auto Indentation
Style
Specifies how the autoindenter will indent your code.
Tabs
Specifies how many spaces a tab has.
Language
Specifies what syntax the GAUSS editor will recognize for syntax
coloring.
Fixup Text Case
While Typing
Language
Keywords
Specifies whether the editor will automatically change the case of
GAUSS keywords when they use the wrong case.
Smooth
Scrolling
Enables or disables smooth scrolling when the window is scrolled
up/down by one line or left/right by one character.
Show Left
Margin
Enables or disables the editor’s margin. The margin is used for
showing breakpoints, bookmarks, or line numbers.
Line Tooltips
on Scroll
Shows the first line number on screen as a tooltip as you scroll up and
down the file.
Misc
5-14
Using the Windows Interface
Enables or disables drag and drop functionality.
Allow Column
Selection
Lets you select and manipulate columns of text.
Confine Caret
to Text
Tells the GAUSS editor to interpret carets as text only rather than as
substitution symbols or text.
Color Syntax
Highlighting
Toggles on or off color syntax highlighting.
Show Horizontal
Scrollbar
Toggles on or off the horizontal scrollbar.
Show Vertical
Scrollbar
Toggles on or off the vertical scrollbar.
Allow Vertical
Splitting
Toggles on or off the ability to split editor panes vertically.
Allow
Horizontal
Splitting
Toggles on or off the ability to split editor panes horizontally.
Line Numbering
Specifies the style and starting digit for line numbering.
Max Undoable
Actions
Sets the number of actions that you can undo.
5.7
5.7.1
Windows GUI
Allow Drag
and Drop
Using GAUSS Keyboard Assignments
Cursor Movement Keys
UP ARROW
Up one line
DOWN ARROW
Down one line
LEFT ARROW
Left one character
5-15
GAUSS User Guide
RIGHT ARROW
Right one character
CTRL+LEFT ARROW
Left one word
CTRL+RIGHT ARROW
Right one word
HOME
Beginning of line
END
End of line
PAGE UP
Next screen up
PAGE DOWN
Next screen down
CTRL+PAGE UP
Scroll window right
CTRL+PAGE DOWN
Scroll window left
CTRL+HOME
Beginning of document
CTRL+END
End of document
5.7.2
Edit Keys
BACKSPACE
Delete character to left of cursor, or delete selected text
DEL
Delete character to right of cursor, or delete selected text
CTRL+INS or CTRL+C
Copy selected text to Windows clipboard
SHIFT+DEL or CTRL+X
Delete selected text and place it onto Windows clipboard
SHIFT+INS or CTRL+V
Paste text from Windows clipboard at the cursor position
CTRL+Z
Undo last editing action
5-16
Using the Windows Interface
5.7.3
Text Selection Keys
SHIFT+UP ARROW
Select one line of text up
SHIFT+DOWN ARROW
Select one line of text down
SHIFT+LEFT ARROW
Select one character to the left
SHIFT+RIGHT ARROW
Select one character to the right
SHIFT+CTRL+LEFT ARROW
Select one word to the left
SHIFT+CTRL+RIGHT ARROW
Select one word to the right
SHIFT+HOME
Select to beginning of the line
SHIFT+END
Select to end of the line
SHIFT+PAGE UP
Select up one screen
SHIFT+PAGE DOWN
Select down one screen
SHIFT+CTRL+HOME
Select text to beginning of document
SHIFT+CTRL+END
Select text to end of document
Command Keys
CTRL+A
Redo
CTRL+C
Copy selection to Windows clipboard
CTRL+D
Open Debug window
CTRL+E
Open Matrix Editor
CTRL+F
Find/Replace text
CTRL+G
Go to specified line number
CTRL+I
Insert GAUSS prompt
Windows GUI
5.7.4
5-17
GAUSS User Guide
CTRL+L
Insert last
CTRL+N
Make next window active
CTRL+O
Open Output window
CTRL+P
Print current window, or selected text
CTRL+Q
Exit GAUSS
CTRL+R
Run selected text
CTRL+S
Save window to file
CTRL+W
Open Command window
CTRL+V
Paste contents of Windows clipboard
CTRL+X
Cut selection to Windows clipboard
CTRL+Z
Undo
5.7.5
Function Keys
F1
Open GAUSS Help system or context-sensitive Help
F2
Go to next bookmark
F3
Find again
F4
Go to next search item in Source Browser
F5
Run Main File
F6
Run Active File
F7
Edit Main File
F8
Step Into
F9
Set/Clear breakpoint
5-18
Using the Windows Interface
F10
Step Over
ALT+F4
Exit GAUSS
ALT+F5
Debug Main File
CTRL+F1
Searches the active libraries for the source code of a function.
CTRL+F2
Toggle bookmark
CTRL+F4
Close active window
CTRL+F5
Compile Main File
CTRL+F6
Compile Active File
CTRL+F10
Step Out
ESC
Unmark marked text
5.7.6
Menu Keys
Configure menu
ALT+D
Debug menu
ALT+E
Edit menu
ALT+F
File menu
ALT+H
Help menu
ALT+R
Run menu
ALT+T
Tools menu
ALT+W
Window menu
ALT+V
View menu
Windows GUI
ALT+C
5-19
Matrix Editor
6.1
6
Using the Matrix Editor
The Matrix Editor lets you view and edit matrix data in your current workspace. You can open the
Matrix Editor from either the Command Input - Output window or a GAUSS edit window by
highlighting a matrix variable name and typing CTRL+E. You can view multiple matrices at the
same time by opening more than one Matrix Editor.
“ttfamily “bfseries “upshape LaTeX Error: File ‘matrixed’ not found.ΩΩSee the LaTeX manual or LaTeX Com
Figure 6.1: Matrix Editor
Editing Matrices
The Matrix Editor will allow you to format matrices in decimal, scientific, Hexadecimal, or as text
characters.
6-1
Matrix Editor
6.1.1
GAUSS User Guide
Just like a spreadsheet, when using the Matrix Editor, you can use your keyboard’s arrow keys to
quickly move between matrix positions. To edit a scalar value, select a cell and press Enter. You
can use the Home and End keys to move to the beginning or end of a scalar. When finished
editing, press Enter again.
6.1.2
Viewing Variables
All variables are treated as matrices in GAUSS. A scalar is simply a 1×1 matrix. A vector is a
(N×1) or (1×N) matrix. So you can use the Matrix Editor to view and monitor the value of any
variable. You can update the value of a variable at any time by using the Reload function. When
using the Matrix Editor to view, edit or monitor smaller matrices, you can minimize space it
occupies on the screen by selecting Minimal View from the View menu.
By using the Auto-reload function, GAUSS will automatically update the values of variables in
the Matrix Editor. Using Auto-reload you can create a watch window.
Setting Watch Variables
Watch Variables allow you to see how variables change in value while debugging a program. A
watch variable can be the name of a matrix, a scalar, an array, a string array, or a string.
The debugger searches for a watch variable in the following order:
• a local variable within a currently active procedure
• a global variable
6.1.3
Matrix Editor Menu Bar
Matrix Menu
The Matrix menu lets you control the data of the Matrix in the Matrix Editor as an entire set.
6-2
Matrix Editor
Load
Clears any existing grid and loads any named matrix from the GAUSS
workspace to the grid.
Reload
Reloads the existing matrix with the name shown on the Title bar.
Auto-Reload
Automatically updates the data shown in the Matrix Editor, creating a
watch window.
Save
Saves the grid as a matrix in the GAUSS workspace. If a matrix of the
same name already exists in the workspace, it is overwritten.
Format Menu
The Format menu lets you control the way the data is presented in the Matrix Editor.
Decimal
Display selected elements as decimal numbers.
Scientific
Display selected elements using scientific notation.
Hexadecimal
Display selected elements as hexadecimal numbers.
Character
Display selected elements as character data.
Precision...
Specify precision of selected elements.
Edit Menu
The Edit menu gives you tools to control the data in the Matrix Editor.
Clears the grid of all values but keep the row and column order.
Preferences
Sets several matrix options, including the number of digits to the right
of the decimal point, cell height and width, and whether pressing the
Enter key moves the cursor down or over one cell. These options, along
with screen position and window state, are saved between sessions.
6-3
Matrix Editor
Clear All
GAUSS User Guide
View Menu
The View menu lets you control the Matrix Editor window. The View menu also lets you control
your view of imaginary numbers.
6-4
Dimension
Specifies which two-dimensional subarray of an N-dimensional array
to display by indexing the N-2 leading dimensions of the array.
Real Parts
Specifies that you want the real parts of imaginary numbers to be
displayed in the Matrix Editor.
Imaginary Parts
Specifies that you want the imaginary parts of numbers to be displayed
in the Matrix Editor.
Minimal View
Minimizes the amount of screen space occupied by the Matrix Editor.
This is especially useful for creating watch windows for single
variables.
Stay on Top
Forces the Matrix Editor window to remain visible on the screen even
when the interface focus has shifted to another window.
Library Tool
Library Tool
7.1
7
Using the Library Tool
The Library Tool lets you quickly manage your libraries. You can add and remove libraries and
you can add and remove files within the libraries.
“ttfamily “bfseries “upshape LaTeX Error: File ‘libtool’ not found.ΩΩSee the LaTeX manual or LaTeX Compa
Figure 7.1: Library Tool
7.1.1
Managing Libraries
Using the New Library button, you can create a new library for organizing your code. You can
remove a library by selecting the Delete Library button.
7-1
GAUSS User Guide
7.1.2
Managing the Library Index
To add absolute path names to the library index, use the Add Paths button. To only use file names
for searching libraries, use the Strip Paths button. Use Rebuild to recompile all the files used in the
library, and rebuild the library index file. Use the Revert to Original button to revert to the
configuration the library was in when the Library Tool was opened.
7.1.3
Managing Library Files
You can add files to a library with the Add button. You can remove files from a library with the
Remove button. After changing source files referred to in a library, select the files in the file list
and update the library index with the Update button. To remove multiple files from a library, select
the files in the file selection window, and use the Clear Selection button.
For more information about libraries, see L, Chapter 18.
7-2
8
The GAUSS Source Browser lets users quickly find, view, and if necessary, modify source code.
Both the TGAUSS and GAUSS Source Browsers can be used to search for external symbols in
active libraries. The GAUSS Source Browser can also be used to search for symbols in any
directory or source file.
8.1
Using the Source Browser in TGAUSS
To start the Source Browser in TGAUSS, type BROWSE followed by a symbol name. When the
Source Browser is active, the prompt displays Browse:. GAUSS searches through all active
libraries for the file in which the symbol is defined. If found, the file containing the source code is
opened in the default editor.
Wildcard (*) searches can also be used. When using wildcard searches, each symbol that the string
matches will be displayed on-screen in a numbered list. To select a specific command to view in
the default editor, select the number from the list.
The Source Browser will remain active until you type CTRL-C to return to the GAUSS prompt.
8-1
Source
Browser
GAUSS Source Browser
GAUSS User Guide
8.2
Using the Source Browser in GAUSS
To open the Source Browser in GAUSS, from the Tools menu select Source Browser.
Using the Source Browser you can search a file for a specified symbol or search across all the
source files in a directory. Using a comma separated list of files and directories in the Look in: list,
you can search multiple locations in a single search. When searching for symbols, you can use
wildcards (*) to further modify the scope of the search.
Note: The Source Browser does not search recursively through sub-folders. To search sub-folders
during a search, add the sub-folder names to the Look in: list.
Once the search is complete, the Source Browser lists where the specified symbol was found. The
Filename column of the Results List shows the file in which the symbol was found. The Line
column shows the line number where symbol was found and the Line Description column shows
the text of the line where the symbol was found.
Search locations typed into the Look in: text box will persist between Source Browser sessions.
“ttfamily “bfseries “upshape LaTeX Error: File ‘sourcebrowse’ not found.ΩΩSee the LaTeX manual or LaTeX
Figure 8.1: Source Browser
Pattern:
Defines search pattern.
Look in:
Limits the scope of the search to specific files or directories. Using a comma
separated list, searches multiple files and directories in a single search.
Match Case
Makes search case-sensitive.
Match whole
word
Limits search to entire words.
Stay on top
Keeps the Source Browser on top even when another window is active.
F4 Opens New
Window
Sets F4 to open new window.
8-2
GAUSS Source Browser
Lets you limit the scope of the search to specific files or directories.
Search
Initiates search.
Results List
Lists occurrences of selected symbol in specified files or directories.
Status
Lists how many occurrences there were, and how many files the symbol
occurred in.
Close
Closes the Source Browser.
8.2.1
Source
Browser
Browse
Opening Files From the Source Browser
Double-click the file name to open a file in its own editor window. When opened, the cursor is
placed at the beginning of the line selected in the Results List. By double-clicking different files in
the Source Browser, you can open each file in its own separate editor window.
Use the F4 key to quickly view or edit the next file in the Results List using the active editor
window. Using the F4 key opens the file in the active editor window and places the cursor at the
beginning of the line in which the symbol was found. The F4 key uses the active editor window to
display the source file; it will not open an editor window to display files. You can use the F4 key
from either the Source Browser or from the active editor window to move to the next occurrence
of the symbol shown in the Results List.
Use SHIFT+F4 to quickly view or edit the previous file in the Results List using the active editor
window. Using the F4 key opens the file in the active editor window and places the cursor at the
beginning of the line in which the symbol was found.
8.2.2
Source Browser Keyboard Controls
UP ARROW
Moves to the previous occurrence in the Results List.
DOWN ARROW
Moves to the next occurrence in the Results List.
HOME
Moves to the first occurrence in the Results List.
END
Moves to the last occurrence in the Results List.
8-3
GAUSS User Guide
F4
Shows the next occurrence in the active editor window.
SHIFT+F4
Shows the previous occurrence in the active editor window.
TAB
Moves to next field.
ENTER
Starts Search.
8-4
GAUSS Help
Help Menu
From the Help menu, you can directly access the online U G, Keyboard Assignments list,
and L R. Pressing F1 also accesses the Help system, displaying either the
I to the U G or, if an object has focus and help can be directly accessed, help
for that object.
9.2
Context-Sensitive Help
GAUSS integrates a context-sensitive Help system to help you use the GAUSS environment and
the GAUSS language. Context-sensitive means that Help for the object with focus is displayed
without navigating through the Help system. For example, to display Help on a keyword in the
GAUSS language in a GAUSS edit window or the Command Input - Output window, place the
insertion point on the keyword and press F1.
Several areas of the GAUSS interface are context-sensitive, including:
9-1
Help
9.1
9
GAUSS User Guide
• GAUSS windows
• Toolbar buttons
• GAUSS menus
• The GAUSS language
For intrinsic commands and functions, the GAUSS L R for the command is
displayed. For other external procedures in active libraries, a window displays a source code file,
allowing you to scroll to the desired symbol.
9.3
SHIFT+F1 Support
If you press SHIFT+F1 or click on the Help toolbar button (an arrow with a question mark), the
pointer changes to a Help pointer (arrow + ?). Click on an object to display the Help system or, if
available, context-sensitive Help for that object.
9.4
CTRL+F1 Support
You can search through all active libraries for any global symbol by placing the cursor on the
symbol name and pressing CTRL+F1.
GAUSS searches through all active libraries for the file that the symbol is defined in. If found, the
file containing the source code is opened in an edit window. If the file contains the code string
“**> symbol name” (without quotes) at the beginning of a line of commented code, the cursor will
be placed at the beginning of that line. If the string is not found in the file, the cursor will be
placed at the beginning of the file.
To properly implement this functionality in your own source code, place
**> symbol name
at the beginning of a line in a comment block.
9-2
GAUSS Help
9.5
ToolTips
A ToolTip is a small label that is displayed when the mouse pointer is held over a GAUSS button.
The ToolTip will give a brief description of the button’s function.
9.6
Other Help
The Gaussians mail list is an e-mail list providing users of GAUSS an easy way to reach other
GAUSS users. Gaussians provides a forum for information exchange, tips and experiences using
GAUSS. For more information about the Gaussians mail list, see the Resource Library page at
http://www.aptech.com. You can also e-mail [email protected] when you have current
Premier Support.
9-3
Help
GAUSS includes full online versions of the GAUSS L R and GAUSS U G
in PDF format. These manuals are available for download; contact Aptech Systems for download
instructions.
Language Fundamentals
10
How can GAUSS be so fast if it is an interpreter? Two reasons. First, GAUSS has a fast
interpreter, and the binary compiled code is compact and efficient. Second, and most significantly,
GAUSS is a matrix language. It is designed to tackle problems that can be solved in terms of
matrix or vector equations. Much of the time lost in interpreting the pseudocode is made up in the
matrix or vector operations.
This chapter will enable you to understand the distinction between “compile time” and “execution
time”, two very different stages in the life of a GAUSS program.
10.1
Expressions
An expression is a matrix, string, constant, function reference, procedure reference, or any
combination of these joined by operators. An expression returns a result that can be assigned to a
10-1
Language
Fundamentals
GAUSS is a compiled language. GAUSS is also an interpreter. A compiled language, because
GAUSS scans the entire program once and translates it into a binary code before it starts to execute
the program. An interpreter, because the binary code is not the native code of the CPU. When
GAUSS executes the binary pseudocode it must “interpret” each instruction for the computer.
GAUSS User Guide
variable with the assignment operator ‘=’.
10.2
Statements
A statement is a complete expression or command. Statements end with a semicolon.
y = x*3;
If an expression has no assignment operator (=), it will be assumed to be an implicit print
statement:
print x*3;
or
x*3;
Here is an example of a statement that is a command rather than an expression:
output on;
Commands cannot be used as a part of an expression.
There can be multiple statements on the same line as long as each statement is terminated with a
semicolon.
10-2
Language Fundamentals
10.2.1
Executable Statements
Executable statements are statements that can be “executed” over and over during the execution
phase of a GAUSS program (execution time). As an executable statement is compiled, binary code
is added to the program being compiled at the current location of the instruction pointer. This
binary code will be executed whenever the interpreter passes through this section of the program.
If this code is in a loop, it will be executed each iteration of the loop.
Here are some examples of executable statements:
y = 34.25;
print y;
x =
Nonexecutable Statements
Nonexecutable statements are statements that have an effect only when the program is compiled
(compile time). They generate no executable code at the current location of the instruction pointer.
Here are two examples:
declare matrix x =
1 2 3 4 ;
external matrix ybar;
Procedure definitions are nonexecutable. They do not generate executable code at the current
location of the instruction pointer.
Here is an example:
10-3
Language
Fundamentals
10.2.2
1 3 7 2 9 4 0 3 ;
GAUSS User Guide
zed = rndn(3,3);
proc sqrtinv(x);
local y;
y = sqrt(x);
retp(y+inv(x));
endp;
zsi = sqrtinv(zed);
There are two executable statements in the example above: the first line and the last line. In the
binary code that is generated, the last line will follow immediately after the first line. The last line
is the call to the procedure. This generates executable code. The procedure definition generates
no code at the current location of the instruction pointer.
There is code generated in the procedure definition, but it is isolated from the rest of the program.
It is executable only within the scope of the procedure and can be reached only by calling the
procedure.
10.3
Programs
A program is any set of statements that are run together at one time. There are two sections within
a program.
10.3.1
Main Section
The main section of the program is all of the code that is compiled together WITHOUT relying on
the autoloader. This means code that is in the main file or is included in the compilation of the
main file with an #include statement. ALL executable code should be in the main section.
There must always be a main section even if it consists only of a call to the one and only procedure
called in the program.
10-4
Language Fundamentals
10.3.2
Secondary Sections
Secondary sections of the program are files that are neither run directly nor included in the main
section with #include statements.
The secondary sections of the program can be left to the autoloader to locate and compile when
they are needed. Secondary sections must have only procedure definitions and other
nonexecutable statements.
#include statements are allowed in secondary sections as long as the file being included does not
violate the above criteria.
Here is an example of a secondary section:
declare matrix tol = 1.0e-15;
10.4
Language
Fundamentals
proc feq(a,b);
retp(abs(a-b) <= tol);
endp;
Compiler Directives
Compiler directives are commands that tell GAUSS how to process a program during compilation.
Directives determine what the final compiled form of a program will be. They can affect part or all
of the source code for a program. Directives are not executable statements and have no effect at
run-time.
The #include statement mentioned earlier is actually a compiler directive. It tells GAUSS to
compile code from a separate file as though it were actually part of the file being compiled. This
code is compiled in at the position of the #include statement.
Here are the compiler directives available in GAUSS:
#define
Define a case-insensitive text-replacement or flag variable.
10-5
GAUSS User Guide
#definecs
Define a case-sensitive text-replacement or flag variable.
#undef
Undefine a text-replacement or flag variable.
#ifdef
Compile code block if a variable has been #define’d.
#ifndef
Compile code block if a variable has not been #define’d.
#iflight
Compile code block if running GAUSS Light.
#ifdos
Compile code block if running DOS.
#ifos2win
Compile code block if running OS/2 or Windows.
#ifunix
Compile code block if running UNIX.
#else
Else clause for #if-#else-#endif code block.
#endif
End of #if-#else-#endif code block.
#include
Include code from another file in program.
#lineson
Compile program with line number and file name records.
#linesoff
Compile program without line number and file name records.
#srcfile
Insert source file name record at this point (currently used when
doing data loop translation).
#srcline
Insert source file line number record at this point (currently used
when doing data loop translation).
The #define statement can be used to define abstract constants. For example, you could define
the default graphics page size as:
#define hpage
#define vpage
10-6
9.0
6.855
Language Fundamentals
and then write your program using hpage and vpage. GAUSS will replace them with 9.0 and
6.855 when it compiles the program. This makes a program much more readable.
The #ifdef–#else–#endif directives allow you to conditionally compile sections of a program,
depending on whether a particular flag variable has been #define’d. For example:
#ifdef log_10
y = log(x);
#else
y = ln(x);
#endif
This allows the same program to calculate answers using different base logarithms, depending on
whether or not the program has a #define log_10 statement at the top.
With #lineson, #linesoff, #srcline, and #srcfile you can include line number and file
name records in your compiled code, so that run-time errors will be easier to track down.
#srcline and #srcfile are currently used by GAUSS when doing data loop translation.
For more information on line number tracking, see D, Section 19.3 and see D
D L, Section 22.3. See also #lineson in the GAUSS L R.
The syntax for #srcfile and #srcline is different than for the other directives that take
arguments. Typically, directives do not take arguments in parentheses; that is, they look like
keywords:
#define red 4
#srcfile and #srcline, however, do take their arguments in parentheses (like procedures):
10-7
Language
Fundamentals
#undef allows you to undefine text-replacement or flag variables so they no longer affect a
program, or so you can #define them again with a different value for a different section of the
program. If you use #definecs to define a case-sensitive variable, you must use the right case
when #undef’ing it.
GAUSS User Guide
#srcline(12)
This allows you to place #srcline statements in the middle of GAUSS commands, so that line
numbers are reported precisely as you want them. For example:
#srcline(1)
#srcline(2)
#srcline(3)
#srcline(4)
print "Here is a multi-line "
"sentence--if it contains a run-time error, "
"you will know exactly "
"which part of the sentence has the problem.";
The argument supplied to #srcfile does not need quotes:
#srcfile(/gauss/test.e)
10.5
Procedures
A procedure allows you to define a new function which you can then use as if it were an intrinsic
function. It is called in the same way as an intrinsic function.
y = myproc(a,b,c);
Procedures are isolated from the rest of your program and cannot be entered except by calling
them. Some or all of the variables inside a procedure can be local variables . local variables
exist only when the procedure is actually executing and then disappear. Local variables cannot get
mixed up with other variables of the same name in your main program or in other procedures.
For details on defining and calling procedures, see P  K, chapter 12.
10-8
Language Fundamentals
10.6
Data Types
There are four basic data types in GAUSS, matrices, N-dimensional arrays, strings and string
arrays. It is not necessary to declare the type of a variable, but it is good programming practice to
respect the types of variables whenever possible. The data type and size can change in the course
of a program.
The declare statement, used for compile-time initialization, enforces type checking.
Short strings of up to 8 bytes can be entered into elements of matrices, to form character matrices
(For details, see C M, Section 10.6.7).
10.6.1
Constants
The following constant types are supported:
Language
Fundamentals
Decimal
Decimal constants can be either integer or floating point values:
1.34e-10
1.34e123
-1.34e+10
-1.34d-10
1.34d10
10-9
GAUSS User Guide
1.34d+10
123.456789345
Up to 18 consecutive digits before and after the decimal point(depending on the platform) are
significant, but the final result will be rounded to double precision if necessary. The range is the
same as for matrices (For details, see M, Section 10.6.2.
String
String constants are enclosed in quotation marks:
“This is a string.”
Hexadecimal Integer
Hexadecimal integer constants are prefixed with 0x:
0x0ab53def2
Hexadecimal Floating Point
Hexadecimal floating point constants are prefixed with 0v. This allows you to input a double
precision value exactly as you want using 16 hexadecimal digits. The highest order byte is to the
left:
0vfff8000000000000
10-10
Language Fundamentals
10.6.2
Matrices
Matrices are 2-dimensional arrays of double precision numbers. All matrices are implicitly
complex, although if it consists only of zeros, the imaginary part may take up no space. Matrices
are stored in row major order. A 2×3 real matrix will be stored in the following way from the
lowest addressed element to the highest addressed element:
[1, 1] [1, 2] [1, 3] [2, 1] [2, 2] [2, 3]
A 2×3 complex matrix will be stored in the following way from the lowest addressed element to
the highest addressed element:
(real part)
[1, 1] [1, 2] [1, 3] [2, 1] [2, 2] [2, 3]
(imaginary part) [1, 1] [1, 2] [1, 3] [2, 1] [2, 2] [2, 3]
All elements of a GAUSS matrix are stored in double precision floating point format, and each
takes up 8 bytes of memory. This is the IEEE 754 format:
Bytes
Data Type
Significant
Digits
Range
8
floating point
15–16
4.19x10−307 ≤ |X| ≤ 1.67x10+308
Matrices with only one element (1×1 matrices) are referred to as scalars, and matrices with only
one row or column (1×N or N×1 matrices) are referred to as vectors.
Any matrix or vector can be indexed with two indices. Vectors can be indexed with one index.
Scalars can be indexed with one or two indices also, because scalars, vectors, and matrices are the
same data type to GAUSS
The majority of functions and operators in GAUSS take matrices as arguments. The following
functions and operators are used for defining, saving, and loading matrices:
10-11
Language
Fundamentals
Conversion between complex and real matrices occurs automatically and is transparent to the user
in most cases. Functions are provided to provide explicit control when necessary.
GAUSS User Guide
[ ]
Indexing matrices.
=
Assignment operator.
|
Vertical concatenation.
∼
Horizontal concatenation.
con
Numeric input from keyboard.
cons
Character input from keyboard.
declare
Compile-time matrix or string initialization.
let
Matrix definition statement.
load
Load matrix (same as loadm).
readr
Read from a GAUSS matrix or data set file.
save
Save matrices, procedures and strings to disk.
saved
Convert a matrix to a GAUSS data set.
stof
Convert string to matrix.
submat
Extract a submatrix.
writer
Write data to a GAUSS data set.
Following are some examples of matrix definition statements.
An assignment statement followed by data enclosed in braces is an implicit let statement. Only
constants are allowed in let statements; operators are illegal. When braces are used in let
statements, commas are used to separate rows. The statement
let x =
or
10-12
1 2 3, 4 5 6, 7 8 9 ;
Language Fundamentals
x =
1 2 3, 4 5 6, 7 8 9 ;
will result in
1 2 3
x= 4 5 6
7 8 9
The statement
let x[3,3] = 1 2 3 4 5 6 7 8 9;
will result in
Language
Fundamentals
1 2 3
x= 4 5 6
7 8 9
The statement
let x[3,3] = 1;
will result in
1 1 1
x= 1 1 1
1 1 1
The statement
let x[3,3];
10-13
GAUSS User Guide
will result in
0 0 0
x= 0 0 0
0 0 0
The statement
let x = 1 2 3 4 5 6 7 8 9;
will result in
1
2
3
4
x= 5
6
7
8
9
Complex constants can be entered in a let statement. In the following example, the + or - is not a
mathematical operator, but connects the two parts of a complex number. There should be no
spaces between the + or - and the parts of the number. If a number has both real and imaginary
parts, the trailing ‘i’ is not necessary. If a number has no real part, you can indicate that it is
imaginary by appending the ‘i’. The statement
let x[2,2] = 1+2i 3-4 5 6i;
will result in
x=
10-14
1 + 2i 3 − 4i
5
0 + 6i
Language Fundamentals
Complex constants can also be used with the declare, con and stof statements.
An “empty matrix” is a matrix that contains no data. Empty matrices are created with the let
statement and braces:
x = {};
Empty matrices are supported by several functions, including rows and cols and the
concatenation (∼,|) operators.
x = {};
hsec0 = hsec;
do until hsec-hsec0 > 6000;
x = x ˜ data_in(hsec-hsec0);
endo;
The ∼ is the horizontal concatenation operator and the | is the vertical concatenation operator. The
statement
y = 1∼2|3∼4;
will be evaluated as
y = (1 ∼ 2) | (3 ∼ 4);
and will result in a 2×2 matrix because horizontal concatenation has precedence over vertical
concatenation:
1 2
3 4
10-15
Language
Fundamentals
You can test whether a matrix is empty by entering rows(x), cols(x) and scalerr(x). If the
matrix is empty rows and cols will return a 0, and scalerr will return 65535.
GAUSS User Guide
The statement
y = 1+1∼2*2|3-2∼6/2;
will be evaluated as
y = ((1 + 1) ∼ (2 ∗ 2)) | ((3 − 2) ∼ (6/2));
and will result in a 2×2 matrix because the arithmetic operators have precedence over
concatenation:
2 4
1 3
For more information, see O P, Section 11.7.
The let command is used to initialize matrices with constant values:
let x[2,2] = 1 2 3 4;
Unlike the concatenation operators, it cannot be used to define matrices in terms of expressions
such as
y = x1-x2∼x2|x3*3∼x4;
The statement
y = x[1:3,5:8];
10-16
Language Fundamentals
will put the intersection of the first three rows and the fifth through eighth columns of x into the
matrix y.
The statement
y = x[1 3 1,5 5 9];
will create a 3×3 matrix y with the intersection of the specified rows and columns pulled from x
(in the indicated order).
The following code
let r = 1 3 1; let c = 5 5 9; y = x[r,c];
Language
Fundamentals
will have the same effect as the previous example, but is more general.
The statement
y[2,4] = 3;
will set the 2,4 element of the existing matrix y to 3. This statement is illegal if y does not have at
least 2 rows and 4 columns.
The statement
x = con(3,2);
will cause the following prompt to be printed in the window:
- (1,1)
10-17
GAUSS User Guide
indicating that the user should enter the [1,1] element of the matrix. Entering a number and then
pressing ENTER will cause a prompt for the next element of the matrix to appear. Pressing ? will
display a help screen, and pressing x will exit.
The statement
load x[] = b:mydata.asc
will load data contained in an ASCII file into an N×1 vector x. (Use rows(x) to find out how
many numbers were loaded, and use reshape(x,N,K) to reshape it to an N×K matrix).
The statement
load x;
will load the matrix x.fmt from disk (using the current load path) into the matrix x in memory.
The statement
open d1 = dat1;
x = readr(d1,100);
will read the first 100 rows of the GAUSS data set dat1.dat.
10.6.3
Sparse Matrices
Many GAUSS operators and commands support the sparse matrix data type. You may use any of
the following commands to create a sparse matrix:
10-18
denseToSp
Converts a dense matrix to a sparse matrix.
denseToSpRE
Converts a dense matrix to a sparse matrix, using a relative epsilon.
Language Fundamentals
packedToSp
Creates a sparse matrix from a packed matrix of non-zero values and
row and column indices.
spCreate
Creates a sparse matrix from vectors of non-zero values, row
indices, and column indices.
spEye
Creates a sparse identity matrix.
spOnes
Generates a sparse matrix containing only ones and zeros
spZeros
Creates a sparse matrix containing no non-zero values.
See S M, Chapter 13, for more information.
10.6.4
N-dimensional Arrays
aconcat
Concatenate conformable matrices and arrays in a user-specified
dimension.
aeye
Create an N-dimensional array in which the planes described by the
two trailing dimensions of the array are equal to the identity.
areshape
Reshape a scalar, matrix, or array into an array of user-specified size.
arrayalloc
Create an N-dimensional array with unspecified contents.
arrayinit
Create an N-dimensional array with a specified fill value.
mattoarray
Convert a matrix to a type array.
See N-D A, Chapter 14, for a more detailed explanation.
10-19
Language
Fundamentals
Many GAUSS commands support arrays of N dimensions. The following commands may be used
to create and manipulate an N-dimensional array:
GAUSS User Guide
10.6.5
Strings
Strings can be used to store the names of files to be opened, messages to be printed, entire files, or
whatever else you might need. Any byte value is legal in a string from 0–255. The buffer where a
string is stored always contains a terminating byte of ASCII 0. This allows passing strings as
arguments to C functions through the Foreign Language Interface.
Here is a partial list of the functions for manipulating strings:
10-20
$+
Combine two strings into one long string.
ˆ
Interpret following name as a variable, not a literal.
chrs
Convert vector of ASCII codes to character string.
dttostr
Convert a matrix containing dates in DT scalar format to a string
array.
ftocv
Character representation of numbers in N×K matrix.
ftos
Character representation of numbers in 1×1 matrix.
ftostrC
Convert a matrix to a string array using a C language format
specification.
getf
Load ASCII or binary file into string.
indcv
Find index of element in character vector.
lower
Convert to lowercase.
stof
Convert string to floating point.
strindx
Find index of a string within a second string.
strlen
Length of a string.
strsect
Extract substring of string.
strsplit
Split an N×1 string vector into an N×K string array of the individual
tokens.
Language Fundamentals
strsplitPad
Split a string vector into a string array of the individual tokens. Pads
on the right with null strings.
strtodt
Convert a string array of dates to a matrix in DT scalar format.
strtof
Convert a string array to a numeric matrix.
strtofcplx
Convert a string array to a complex numeric matrix.
upper
Convert to uppercase.
vals
Convert from string to numeric vector of ASCII codes.
Strings can be created like this:
x = "example string";
Language
Fundamentals
or
x = cons;
/* keyboard input */
x = getf("myfile",0);
/* read a file into a string */
or
They can be printed like this:
print x;
A character matrix must have a ‘$’ prefixed to it in a print statement:
print $x;
10-21
GAUSS User Guide
A string can be saved to disk with the save command in a file with a .fst extension and then
loaded with the load command:
save x;
loads x;
or
loads x=x.fst;
The backslash is used as the escape character inside double quotes to enter special characters:
"\b"
"\e"
"\f"
"\g"
"\l"
"\r"
"\t"
"\\"
"\###"
backspace (ASCII 8)
escape (ASCII 27)
formfeed (ASCII 12)
beep (ASCII 7)
line feed (ASCII 10)
carriage return (ASCII 13)
tab (ASCII 9)
a backslash
the ASCII character whose decimal value is “###”.
When entering DOS pathnames in double quotes, two backslashes must be used to insert one
backslash:
st = "c:\\gauss\\myprog.prg";
An important use of strings and character elements of matrices is with the substitution operator (ˆ).
In the command
create f1 = olsdat with x,4,2;
10-22
Language Fundamentals
by default, GAUSS will interpret the olsdat as a literal; that is, the literal name of the GAUSS
data file you want to create. It will also interpret the x as the literal prefix string for the variable
names: x1 x2 x3 x4.
If you want to get the data set name from a string variable, the substitution operator (ˆ) could be
used as:
dataset="olsdat";
create f1=ˆdataset with x,4,2;
If you want to get the data set name from a string variable and the variable names from a character
vector, use
Language
Fundamentals
dataset="olsdat";
let vnames=age pay sex;
create f1=ˆdataset with ˆvnames,0,2;
The substitution operator (ˆ) works with load and save also:
lpath="/gauss/procs";
name="mydata";
load path=ˆlpath x=ˆname;
command="dir *.fmt";
The general syntax is:
ˆvariable name
Expressions are not allowed. The following commands are supported with the substitution
operator (ˆ):
10-23
GAUSS User Guide
create f1=ˆdataset with ˆvnames,0,2;
create f1=ˆdataset using ˆcmdfile;
open f1=ˆdataset;
output file=ˆoutfile;
load x=ˆdatafile;
load path=ˆlpath x,y,z,t,w;
loadexe buf=ˆexefile;
save ˆname=x;
save path=ˆspath;
dos ˆcmdstr;
run ˆprog;
msym ˆmstring;
10.6.6
String Arrays
String arrays are N×K matrices of strings. Here is a partial list of the functions for manipulating
string arrays:
$|
Vertical string array concatenation operator.
$∼
Horizontal string array concatenation operator.
[ ]
Extract subarrays or individual strings from their corresponding
array,
or assign their values.
10-24
0
Transpose operator.
.0
Bookkeeping transpose operator.
declare
Initialize variables at compile time.
delete
Delete specified global symbols.
fgetsa
Read multiple lines of text from a file.
fgetsat
Reads multiple lines of text from a file, discarding newlines.
Language Fundamentals
format
Define output format for matrices, string arrays, and strings.
fputs
Write strings to a file.
fputst
Write strings to a file, appending newlines.
let
Initialize matrices, strings, and string arrays.
loads
Load a string or string array file (.fst file).
lprint
Print expressions to the printer.
lshow
Print global symbol table to the printer.
print
Print expressions on window and/or auxiliary output.
reshape
Reshape a matrix or string array to new dimensions.
save
Save matrix, string array, string, procedure, function or keyword to
disk and gives the disk file either a .fmt, .fst or .fcg extension.
Display global symbol table.
sortcc
Quick-sort rows of matrix or string array based on character column.
type
Indicate whether variable passed as argument is matrix, string, or
string array.
typecv
Indicate whether variables named in argument are strings, string
arrays, matrices, procedures, functions or keywords.
varget
Access the global variable named by a string array.
varput
Assign the global variable named by a string array.
vec
Stack columns of a matrix or string array to form a column vector.
vecr
Stack rows of a matrix or string array to form a column vector.
String arrays are created through the use of the string array concatenation operators. Below is a
contrast of the horizontal string and horizontal string array concatenation operators.
10-25
Language
Fundamentals
show
GAUSS User Guide
x = "age";
y = "pay";
n = "sex";
s = x $+ y $+ n;
sa = x $∼ y $∼ n;
s = agepaysex
sa = age
10.6.7
pay
sex
Character Matrices
Matrices can have either numeric or character elements. For convenience, a matrix containing
character elements is referred to as a character matrix.
A character matrix is not a separate data type, but gives you the ability to store and manipulate
data elements that are composed of ASCII characters as well as floating point numbers. For
example, you may want to concatenate a column vector containing the names of the variables in an
analysis onto a matrix containing the coefficients, standard errors, t-statistic, and p-value. You can
then print out the entire matrix with a separate format for each column with one call to the
function printfm.
The logic of the programs will dictate the type of data assigned to a matrix, and the increased
flexibility allowed by being able to bundle both types of data together in a single matrix can be
very powerful. You could, for instance, create a moment matrix from your data, concatenate a new
row onto it containing the names of the variables and save it to disk with the save command.
Numeric matrices are double precision, which means that each element is stored in 8 bytes. A
character matrix can thus have elements of up to 8 characters.
GAUSS does not automatically keep track of whether a matrix contains character or numeric
information. The ASCII to GAUSS conversion program ATOG will record the types of variables
in a data set when it creates it. The create command will, also. The function vartypef gets a
vector of variable type information from a data set. This vector of ones and zeros can be used by
printfm when printing your data. Since GAUSS does not know whether a matrix has character or
10-26
Language Fundamentals
numeric information, it is up to you to specify which type of data it contains when printing the
contents of the matrix. (For details, see print and printfm in the GAUSS L R.)
Most functions that take a string argument will take an element of a character matrix also,
interpreting it as a string of up to 8 characters.
10.6.8
Date and Time Formats
DT Scalar Format
The DT scalar format is a double precision representation of the date and time. In the DT scalar
format, the number
20010421183207
Language
Fundamentals
represents 18:32:07 or 6:32:07 PM on April 21, 2001.
DTV Vector Format
The DTV vector is a 1×8 vector. The format for the DTV vector is:
[1]
[2]
[3]
[4]
[5]
[6]
[7]
[8]
Year
Month, 1-12
Day of month, 1-31
Hour of day, 0-23
Minute of hour, 0-59
Second of minute, 0-59
Day of week, 0-6 where 0 is Sunday
Day since beginning of year, 0-365
UTC Scalar Format
The UTC scalar format is the number of seconds since January 1, 1970, Greenwich Mean Time.
10-27
GAUSS User Guide
10.6.9
Special Data Types
The IEEE floating point format has many encodings that have special meaning. The print
command will print them accurately so that you can tell if your calculation is producing
meaningful results.
NaN
There are many floating point encodings which do not correspond to a real number. These
encodings are referred to as NaN’s. NaN stands for Not A Number.
Certain numerical errors will cause the math coprocessor to create a NaN called an “indefinite”.
This will be printed as a -NaN when using the print command. These values are created by the
following operations:
• +∞ plus −∞
• +∞ minus +∞
• −∞ minus −∞
• 0∗∞
• ∞/∞
• 0/0
• Operations where one or both operands is a NaN
• Trigonometric functions involving ∞
INF
When the math coprocessor overflows, the result will be a properly signed infinity. Subsequent
calculations will not deal well with an infinity; it usually signals an error in your program. The
result of an operation involving an infinity is most often a NaN.
10-28
Language Fundamentals
DEN, UNN
When some math coprocessors underflow, they may do so gradually by shifting the significand of
the number as necessary to keep the exponent in range. The result of this is a denormal (DEN).
When denormals are used in calculations, they are usually handled automatically in an appropriate
way. The result will either be an unnormal (UNN), which like the denormal represents a number
very close to zero, or a normal, depending on how significant the effect of the denormal was in the
calculation. In some cases the result will be a NaN.
Following are some procedures for dealing with these values. These procedures are not defined in
the Run-Time Library. If you want to use them, you will need to define them yourself.
The procedure isindef will return 1 (true) if the matrix passed to it contains any NaN’s that are
the indefinite mentioned earlier. The GAUSS missing value code as well as GAUSS scalar error
codes are NaN’s, but this procedure tests only for indefinite:
Be sure to call gausset before calling isindef. gausset will initialize the value of the global
__INDEFn to a platform-specific encoding.
The procedure normal will return a matrix with all denormals and unnormals set to zero.
proc normal(x);
retp(x .* (abs(x) .> 4.19e-307));
endp;
The procedure isinf, will return 1 (true) if the matrix passed to it contains any infinities:
proc isinf(x);
local plus,minus;
plus = __INFp;
10-29
Language
Fundamentals
proc isindef(x);
retp(not x $/= __INDEFn);
endp;
GAUSS User Guide
minus = __INFn;
retp(not x /= plus or not x /= minus);
endp;
Be sure to call gausset before calling isinf. gausset will initialize the values of the globals
__INFn and __INFp to platform specific encodings.
10.7
Operator Precedence
The order in which an expression is evaluated is determined by the precedence of the operators
involved and the order in which they are used. For example, the * and / operators have a higher
precedence than the + and - operators. In expressions that contain these operators, the operand
pairs associated with the * or / operator are evaluated first. Whether * or / is evaluated first
depends on which comes first in the particular expression. For a listing of the precedence of all
operators, see O P, Section 11.7.
The expression
-5+3/4+6*3
is evaluated as
(−5) + (3/4) + (6 ∗ 3)
Within a term, operators of equal precedence are evaluated from left to right.
The term
2ˆ3ˆ7
10-30
Language Fundamentals
is evaluated
(23 )7
In the expression
f1(x)*f2(y)
f1 is evaluated before f2.
Here are some examples:
Evaluation
a+b*c+d
(a + (b ∗ c)) + d
-2+4-6*inv(8)/9
((−2) + 4) − ((6 ∗ inv(8))/9)
3.14ˆ5*6/(2+sqrt(3)/4)
((3.145 ) ∗ 6)/(2 + (sqrt(3)/4))
-a+b*cˆ2
(−a) + (b ∗ (c2 ))
a+b-c+d-e
(((a + b) − c) + d) − e
aˆbˆc*d
((ab )c ) ∗ d
a*b/d*c
((a ∗ b)/d) ∗ c
aˆb+c*d
(ab ) + (c ∗ d)
2ˆ4!
2(4!)
2*3!
2 ∗ (3!)
Language
Fundamentals
Expression
10-31
GAUSS User Guide
10.8
Flow Control
A computer language needs facilities for decision making and looping to control the order in
which computations are done. GAUSS has several kinds of flow control statements.
10.8.1
Looping
do loop
The do statement can be used in GAUSS to control looping.
do while scalar expression; /* loop if expression is true */
.
.
statements
.
.
endo;
also
do until scalar expression; /* loop if expression is false */
.
.
statements
.
.
endo;
The scalar expression is any expression that returns a scalar result. The expression will be
evaluated as TRUE if its real part is nonzero and FALSE if it is zero. There is no counter variable
that is automatically incremented in a do loop. If one is used, it must be set to its initial value
before the loop is entered and explicitly incremented or decremented inside the loop.
The following example illustrates nested do loops that use counter variables.
10-32
Language Fundamentals
format /rdn 1,0;
space = "
";
comma = ",";
i = 1;
do while i <= 4;
j = 1;
do while j <= 3;
print space i comma j;;
j = j+1;
endo;
i = i+1;
print;
endo;
This will print:
1, 2
2, 2
3, 2
4, 2
1, 3
2, 3
3, 3
4, 3
Language
Fundamentals
1, 1
2, 1
3, 1
4, 1
Use the relational and logical operators without the dot ‘.’ in the expression that controls a do
loop. These operators always return a scalar result.
break and continue are used within do loops to control execution flow. When break is
encountered, the program will jump to the statement following the endo. This terminates the loop.
When continue is encountered, the program will jump up to the top of the loop and reevaluate
the while or until expression. This allows you to reiterate the loop without executing any more
of the statements inside the loop:
do until eof(fp);
/* continue jumps here */
x = packr(readr(fp,100));
if scalmiss(x);
continue;
/* iterate again */
10-33
GAUSS User Guide
endif;
s = s + sumc(x);
count = count + rows(x);
if count >= 10000;
break;
/* break out of loop */
endif;
endo;
mean = s / count;
/* break jumps here */
for loop
The fastest looping construct in GAUSS is the for loop:
for counter (start, stop, step);
.
.
statements
.
.
endfor;
counter is the literal name of the counter variable. start, stop and step are scalar expressions. start
is the initial value, stop is the final value and step is the increment.
break and continue are also supported by for loops. (For more information, see for in the
GAUSS L R.)
10-34
Language Fundamentals
10.8.2
Conditional Branching
The if statement controls conditional branching:
if scalar expression;
.
.
statements
.
.
elseif scalar expression;
.
.
statements
.
.
Language
Fundamentals
else;
.
.
statements
.
.
endif;
The scalar expression is any expression that returns a scalar result. The expression will be
evaluated as TRUE if its real part is nonzero and FALSE if it is zero.
GAUSS will test the expression after the if statement. If it is TRUE, then the first list of
statements is executed. If it is FALSE, then GAUSS will move to the expression after the first
elseif statement, if there is one, and test it. It will keep testing expressions and will execute the
first list of statements that corresponds to a TRUE expression. If no expression is TRUE, then the
list of statements following the else statement is executed. After the appropriate list of statements
is executed, the program will go to the statement following the endif and continue on.
Use the relational and logical operators without the dot ‘.’ in the expression that controls an if or
elseif statement. These operators always return a scalar result.
10-35
GAUSS User Guide
if statements can be nested.
One endif is required per if clause. If an else statement is used, there may be only one per if
clause. There may be as many elseif’s as are required. There need not be any elseif’s or any
else statement within an if clause.
10.8.3
Unconditional Branching
The goto and gosub statements control unconditional branching. The target of both a goto and a
gosub is a label.
goto
A goto is an unconditional jump to a label with no return:
label:
.
.
goto label;
Parameters can be passed with a goto. The number of parameters is limited by available stack
space. This is helpful for common exit routines:
.
.
goto errout("Matrix singular");
.
.
goto errout("File not found");
.
.
errout:
10-36
Language Fundamentals
pop errmsg;
errorlog errmsg;
end;
gosub
With a gosub, the address of the gosub statement is remembered and when a return statement is
encountered, the program will resume executing at the statement following the gosub.
Parameters can be passed with a gosub in the same way as a goto. With a gosub it is also
possible to return parameters with the return statement.
Subroutines are not isolated from the rest of your program and the variables referred to between
the label and the return statement can be accessed from other places in your program.
10.9
Functions
Single line functions that return one item can be defined with the fn statement.
fn area(r) = pi * r * r;
These functions can be called in the same way as intrinsic functions. The above function could be
used in the following program sequence.
diameter = 3;
radius = 3 / 2;
a = area(radius);
10-37
Language
Fundamentals
Since a subroutine is only an address marked by a label, there can be subroutines inside of
procedures. The variables used in these subroutines are the same variables that are known inside
the procedure. They will not be unique to the subroutine, but they may be locals that are unique to
the procedure that the subroutine is in. (For details, see gosub in the GAUSS L
R.)
GAUSS User Guide
10.10
Rules of Syntax
This section lists the general rules of syntax for GAUSS programs.
10.10.1
Statements
A GAUSS program consists of a series of statements. A statement is a complete expression or
command. Statements in GAUSS end with a semicolon with one exception: from the GAUSS
command line, the final semicolon in an interactive program is implicit if it is not explicitly given:
(gauss) x=5; z=rndn(3,3); y=x+z
Column position is not significant. Blank lines are allowed. Inside a statement and outside of
double quotes, the carriage return/line feed at the end of a physical line will be converted to a
space character as the program is compiled.
A statement containing a quoted string can be continued across several lines with a backslash as
follows.
s = "This is one really long string that would be "\
"difficult to assign in just a single line.";
10.10.2
Case
GAUSS does not distinguish between uppercase and lowercase except inside double quotes.
10.10.3
Comments
// This comments out all text between the ’//’ and the end of
// the line
10-38
Language Fundamentals
/* This kind of comment can be nested */
@ We consider this kind of comment to be obsolete, but it is
supported for backwards compatibility @
10.10.4
Extraneous Spaces
Extraneous spaces are significant in print and lprint statements where the space is a delimiter
between expressions:
print x y z;
In print and lprint statements, spaces can be used in expressions that are in parentheses:
Language
Fundamentals
print (x * y) (x + y);
10.10.5
Symbol Names
The names of matrices, strings, procedures, and functions can be up to 32 characters long. The
characters must be alphanumeric or an underscore. The first character must be alphabetic or an
underscore.
10.10.6
Labels
A label is used as the target of a goto or a gosub. The rules for naming labels are the same as for
matrices, strings, procedures, and functions. A label is followed immediately by a colon:
here:
10-39
GAUSS User Guide
The reference to a label does not use a colon:
goto here;
10.10.7
Assignment Statements
The assignment operator is the equal sign ‘=’:
y = x + z;
Multiple assignments must be enclosed in braces ‘{ }’:
mant,pow
= base10(x);
The comparison operator (equal to) is two equal signs ‘= =’:
if x =\,= y;
print "x is equal to y";
endif;
10.10.8
Function Arguments
The arguments to functions are enclosed in parentheses ‘( )’:
y = sqrt(x);
10-40
Language Fundamentals
10.10.9
Indexing Matrices
Brackets ‘[ ]’ are used to index matrices:
x = { 1
3
3
8
6
2
7
7
9
1
3,
5,
4,
5,
8 };
y = x[3,3];
z = x[1 2:4,1 3];
Vectors can be indexed with either one or two indices:
Language
Fundamentals
v = 1 2 3 4 5 6 7 8 9 ;
k = v[3];
j = v[1,6:9];
x[2,3] returns the element in the second row and the third column of x.
x[1 3 5,4 7] returns the submatrix that is the intersection of rows 1, 3, and 5 and columns 4 and
7.
x[.,3] returns the third column of x.
x[3:5,.] returns the submatrix containing the third through the fifth rows of x.
The indexing operator will take vector arguments for submatrix extraction or submatrix
assignments:
y = x[rv,cv];
y[rv,cv] = x;
10-41
GAUSS User Guide
rv and cv can be any expressions returning vectors or matrices. The elements of rv will be used
as the row indices and the elements of cv will be used as the column indices. If rv is a scalar 0, all
rows will be used; if cv is a scalar 0, all columns will be used. If a vector is used in an index
expression, it is illegal to use the space operator or the colon operator on the same side of the
comma as the vector.
10.10.10
Arrays of Matrices and Strings
It is possible to index sets of matrices or strings using the varget function.
In this example, a set of matrix names is assigned to mvec. The name y is indexed from mvec and
passed to varget which will return the global matrix y. The returned matrix is inverted and
assigned to g:
mvec = { x y z a };
i = 2;
g = inv(varget(mvec[i]));
The following procedure can be used to index the matrices in mvec more directly:
proc imvec(i);
retp(varget(mvec[i]));
endp;
Then imvec(i) will equal the matrix whose name is in the ith element of mvec.
In the example above, the procedure imvec() was written so that it always operates on the vector
mvec. The following procedure makes it possible to pass in the vector of names being used:
proc get(array,i);
retp(varget(array[i]));
endp;
10-42
Language Fundamentals
Then get(mvec,3) will return the 3rd matrix listed in mvec.
proc put(x,array,i);
retp(varput(x,array[i]));
endp;
And put(x,mvec,3) will assign x to the 3rd matrix listed in mvec and return a 1 if successful or a
0 if it fails.
10.10.11
Arrays of Procedures
It is also possible to index procedures. The ampersand operator (&) is used to return a pointer to a
procedure.
Language
Fundamentals
Assume that f1, f2, and f3 are procedures that take a single argument. The following code
defines a procedure fi that will return the value of the ith procedure, evaluated at x.
nms = &f1 | &f2 | &f3;
proc fi(x,i);
local f;
f = nms[i];
local f:proc;
retp( f(x) );
endp;
fi(x,2) will return f2(x). The ampersand is used to return the pointers to the procedures. nms is
a numeric vector that contains a set of pointers. The local statement is used twice. The first tells
the compiler that f is a local matrix. The ith pointer, which is just a number, is assigned to f. Then
the second local statement tells the compiler to treat f as a procedure from this point on; thus the
subsequent statement f(x) is interpreted as a procedure call.
10-43
Operators
11.1
11
Element-by-Element Operators
Element-by-element operators share common rules of conformability. Some functions that have
two arguments also operate according to the same rules.
matrix
op
matrix
matrix
scalar
op
op
scalar
matrix
matrix
vector
op
op
vector
matrix
vector
op
vector
11-1
Operators
Element-by-element operators handle those situations in which matrices are not conformable
according to standard rules of matrix algebra. When a matrix is said to be E×E conformable, it
refers to this element-by-element conformability . The following cases are supported:
GAUSS User Guide
In a typical expression involving an element-by-element operator
z = x + y;
conformability is defined as follows:
• If x and y are the same size, the operations are carried out corresponding element by
corresponding element:
1 3 2
x= 4 5 1
3 7 4
2 4 3
y= 3 1 4
6 1 2
3 7 5
z= 7 6 5
9 8 6
• If x is a matrix and y is a scalar, or vice versa, then the scalar is operated on with respect to
every element in the matrix. For example, x + 2 will add 2 to every element of x:
1 3 2
x= 4 5 1
3 7 4
y=
2
3 5 4
z= 6 7 3
5 9 6
11-2
Operators
• If x is an N×1 column vector and y is an N×K matrix, or vice versa, the vector is swept
“across” the matrix:
vector
1
4
3
matrix
−→
−→
−→
2
3
6
4
1
1
3
4
2
result
3
7
9
5
5
4
4
8
5
• If x is an 1×K column vector and y is an N×K matrix, or vice versa, then the vector is swept
“down” the matrix:
vector
4
3
↓
↓
↓
matrix
2
3
6
4
1
1
3
4
2
result
4
5
8
8
5
5
6
7
5
Operators
2
• When one argument is a row vector and the other is a column vector, the result of an
element-by-element operation will be the “table” of the two:
11-3
GAUSS User Guide
row vector
column vector
3
2
5
2
4
3
1
5
4
7
7
6
9
6
5
8
4
3
6
If x and y are such that none of these conditions apply, the matrices are not conformable to these
operations and an error message will be generated.
11.2
Matrix Operators
The following operators work on matrices. Some assume numeric data and others will work on
either character or numeric data.
11.2.1
Numeric Operators
For details on how matrix conformability is defined for element-by-element operators, see
E--E O, Section 11.1.
+
Addition
y = x + z;
Performs element-by-element addition.
−
Subtraction or negation
y = x - z;
y = -k;
11-4
Operators
Performs element-by-element subtraction or the negation of all elements, depending on
context.
*
Matrix multiplication or multiplication
y = x * z;
When z has the same number of rows as x has columns, this will perform matrix
multiplication (inner product). If x or z are scalar, this performs standard
element-by-element multiplication.
/
Division or linear equation solution
x = b / A;
If A and b are scalars, this performs standard division. If one of the operands is a matrix and
the other is scalar, the result is a matrix the same size with the results of the divisions
between the scalar and the corresponding elements of the matrix. Use ./ for
element-by-element division of matrices.
If b and A are conformable, this operator solves the linear matrix equation
Ax = b
• If A is a square matrix and has the same number of rows as b, this statement will solve
the system of linear equations using an LU decomposition.
• If A is rectangular with the same number of rows as b, this statement will produce the
least squares solutions by forming the normal equations and using the Cholesky
decomposition to get the solution:
x=
A0 b
A0 A
If trap 2 is set, missing values will be handled with pairwise deletion.
%
Modulo division
11-5
Operators
Linear equation solution is performed in the following cases:
GAUSS User Guide
y = x %z;
For integers, this returns the integer value that is the remainder of the integer division of x
by z. If x or z is noninteger, it will first be rounded to the nearest integer. This is an
element-by-element operator.
!
Factorial
y = x!;
Computes the factorial of every element in the matrix x. Nonintegers are rounded to the
nearest integer before the factorial operator is applied. This will not work with complex
matrices. If x is complex, a fatal error will be generated.
.*
Element-by-element multiplication
y = x .* z;
If x is a column vector, and z is a row vector (or vice versa), the “outer product” or “table” of
the two will be computed. (For comformability rules, see E--E O,
Section 11.1.)
./
Element-by-element division
y = x ./ z;
ˆ
Element-by-element exponentiation
y = xˆz;
If x is negative, z must be an integer.
.ˆ
Same as ˆ
.*. Kronecker (tensor) product
11-6
Operators
y = x .*.
z;
This results in a matrix in which every element in x has been multiplied (scalar
multiplication) by the matrix z. For example:
x = { 1 2,
3 4 };
z = { 4 5 6,
7 8 9 };
y = x .*. z;
x=
1 2
3 4
z=
4 5 6
7 8 9
∼
Operators
4 5 6 8 10 12
7 8 9 14 16 18
y=
12 15 18 16 20 24
21 24 27 28 32 36
Horizontal direct product
z = x *∼ y;
x=
1 2
3 4
y=
5 6
7 8
11-7
GAUSS User Guide
z=
5 6 10 12
21 24 28 32
The input matrices x and y must have the same number of rows. The result will have
cols(x) * cols(y) columns.
11.2.2
0
Other Matrix Operators
Transpose operator
y = x0 ;
The columns of y will contain the same values as the rows of x and the rows of y will
contain the same values as the columns of x. For complex matrices this computes the
complex conjugate transpose.
If an operand immediately follows the transpose operator, the 0 will be interpreted as 0 *.
Thus y = x0 x is equivalent to y = x0 *x.
.0
Bookkeeping transpose operator
y = x.0 ;
This is provided primarily as a matrix handling tool for complex matrices. For all matrices,
the columns of y will contain the same values as the rows of x and the rows of y will contain
the same values as the columns of x. The complex conjugate transpose is NOT computed
when you use .0 .
If an operand immediately follows the bookkeeping transpose operator, the .0 will be
interpreted as .0 *. Thus y = x.0 x is equivalent to y = x.0 *x.
|
Vertical concatenation
z = x|y;
x=
11-8
1 2 3
3 4 5
Operators
y= 7 8 9
1 2 3
z= 3 4 5
7 8 9
∼
Horizontal concatenation
z = x∼y;
11.3
x=
1 2
3 4
y=
5 6
7 8
z=
1 2 5 6
3 4 7 8
Relational Operators
Operators
For details on how matrix conformability is defined for element-by-element operators, see
E--E O, Section 11.1
Each of these operators has two equivalent representations. Either can be used (for example, < or
lt), depending only upon preference. The alphabetic form should be surrounded by spaces.
A third form of these operators has a ‘$’ and is used for comparisons between character data and
for comparisons between strings or string arrays. The comparisons are done byte by byte starting
with the lowest addressed byte of the elements being compared.
The equality comparison operators (<=, = =, >=, /=) and their dot equivalents can be used to test
for missing values and the NaN that is created by floating point exceptions. Less than and greater
11-9
GAUSS User Guide
than comparisons are not meaningful with missings or NaN’s, but equal and not equal are valid.
These operators are sign-insensitive for missings, NaN’s, and zeros.
The string ‘$’ versions of these operators can also be used to test missings, NaN’s and zeros.
Because they do a strict byte-to-byte comparison, they are sensitive to the sign bit. Missings,
NaN’s, and zeros can all have the sign bit set to 0 or 1, depending on how they were generated and
have been used in a program.
If the relational operator is NOT preceded by a dot ‘.’, then the result is always a scalar 1 or 0,
based upon a comparison of all elements of x and y. All comparisons must be true for the
relational operator to return TRUE.
By this definition, then
if x /= y;
is interpreted as: “if every element of x is not equal to the corresponding element of y”. To check
if two matrices are not identical, use
if not x = = y;
For complex matrices, the = =, /=, .= = and ./= operators compare both the real and imaginary
parts of the matrices; all other relational operators compare only the real parts.
• Less than
z = x < y;
z = x lt y;
z = x $< y;
• Less than or equal to
z = x <= y;
11-10
Operators
z = x le y;
z = x $<= y;
• Equal to
z = x = = y;
z = x eq y;
z = x $= = y;
• Not equal
z = x /= y;
z = x ne y;
z = x $/= y;
• Greater than or equal to
z = x >= y;
z = x ge y;
Operators
z = x $>= y;
• Greater than
z = x > y;
z = x gt y;
z = x $> y;
If the relational operator IS preceded by a dot ‘.’, then the result will be a matrix of 1’s and 0’s,
based upon an element-by-element comparison of x and y.
11-11
GAUSS User Guide
• Element-by-element less than
z = x .< y;
z = x .lt y;
z = x .$< y;
• Element-by-element less than or equal to
z = x .<= y;
z = x .le y;
z = x .$<= y;
• Element-by-element equal to
z = x .= = y;
z = x .eq y;
z = x .$= = y;
• Element-by-element not equal to
z = x ./= y;
z = x .ne y;
z = x .$/= y;
• Element-by-element greater than or equal to
z = x .>= y;
z = x .ge y;
z = x .$>= y;
11-12
Operators
• Element-by-element greater than
z = x .> y;
z = x .gt y;
z = x .$> y;
11.4
Logical Operators
The logical operators perform logical or Boolean operations on numeric values. On input a
nonzero value is considered TRUE and a zero value is considered FALSE. The logical operators
return a 1 if TRUE and a 0 if FALSE. Decisions are based on the following truth tables:
Complement
not X
F
T
Operators
X
T
F
Conjunction
X
T
T
F
F
Y
T
F
T
F
X and Y
T
F
F
F
11-13
GAUSS User Guide
Disjunction
X
T
T
F
F
Y
T
F
T
F
X or Y
T
T
T
F
Exclusive Or
X
T
T
F
F
Y
T
F
T
F
X xor Y
F
T
T
F
Equivalence
X
T
T
F
F
Y
T
F
T
F
X eqv Y
T
F
F
T
For complex matrices, the logical operators consider only the real part of the matrices.
The following operators require scalar arguments. These are the ones to use in if and do
statements:
• Complement
z = not x;
• Conjunction
11-14
Operators
z = x and y;
• Disjunction
z = x or y;
• Exclusive or
z = x xor y;
• Equivalence
z = x eqv y;
If the logical operator is preceded by a dot ‘.’, the result will be a matrix of 1’s and 0’s based upon
an element-by-element logical comparison of x and y:
• Element-by-element logical complement
z = .not x;
• Element-by-element conjunction
Operators
z = x .and y;
• Element-by-element disjunction
z = x .or y;
• Element-by-element exclusive or
z = x .xor y;
• Element-by-element equivalence
z = x .eqv y;
11-15
GAUSS User Guide
11.5
Other Operators
Assignment Operator
Assignments are done with one equal sign:
y = 3;
Comma
Commas are used to delimit lists:
clear x,y,z;
to separate row indices from column indices within brackets:
y = x[3,5];
and to separate arguments of functions within parentheses:
y = momentd(x,d);
Period
Dots are used in brackets to signify “all rows” or “all columns”:
y = x[.,5];
11-16
Operators
Space
Spaces are used inside of index brackets to separate indices:
y = x[1 3 5,3 5 9];
No extraneous spaces are allowed immediately before or after the comma, or immediately after the
left bracket or before the right bracket.
Spaces are also used in print and lprint statements to separate the separate expressions to be
printed:
print x/2 2*sqrt(x);
No extraneous spaces are allowed within expressions in print or lprint statements unless the
expression is enclosed in parentheses:
print (x / 2) (2 * sqrt(x));
Colon
Operators
A colon is used within brackets to create a continuous range of indices:
y = x[1:5,.];
Ampersand
The (&) ampersand operator will return a pointer to a procedure (proc), function (fn), or structure
(struct). It is used when passing procedures or functions to other functions, when indexing
procedures, and when initializing structure pointers. (For more information, see I
P, Section 12.5 or S P, Section 16.2.)
11-17
GAUSS User Guide
String Concatenation
x = "dog";
y = "cat";
z = x $+ y;
print z;
dogcat
If the first argument is of type string, the result will be of type string. If the first argument is of
type matrix, the result will be of type matrix. Here are some examples:
y = 0 $+ "caterpillar";
The result will be a 1×1 matrix containing ‘caterpil’.
y = zeros(3,1) $+ "cat";
The result will be a 3×1 matrix, each element containing ‘cat’.
If we use the y created above in the following:
k = y $+ "fish";
The result will be a 3×1 matrix with each element containing ‘catfish’.
If we then use k created above:
t = "" $+ k[1,1];
The result will be a string containing ‘catfish’.
If we used the same k to create z as follows:
11-18
Operators
z = "dog" $+ k[1,1];
The resulting z will be a string containing ‘dogcatfish’.
String Array Concatenation
$| Vertical string array concatenation
x = "dog";
y = "fish";
k = x $| y;
print k;
dog
fish
$∼ Horizontal string array concatenation
x = "dog";
y = "fish";
k = x $˜ y;
print k;
Operators
dog
fish
String Variable Substitution
In a command like the following:
create f1 = olsdat with x,4,2;
by default GAUSS will interpret olsdat as the literal name of the GAUSS data file you want to
create. It will also interpret x as the literal prefix string for the variable names x1 x2 x3 x4.
11-19
GAUSS User Guide
To get the data set name from a string variable, the substitution operator (ˆ) could be used as
follows:
dataset = "olsdat";
create f1 = ˆdataset with x,4,2;
To get the data set name from a string variable and the variable names from a character vector, use
the following:
dataset = "olsdat";
vnames = { age, pay, sex };
create f1 = ˆdataset with ˆvnames,0,2;
The general syntax is:
ˆvariable name
Expressions are not allowed.
The following commands are currently supported with the substitution operator (ˆ) in the current
version.
create f1 = ˆdataset with ˆvnames,0,2;
create f1 = ˆdataset using ˆcmdfile;
open f1 = ˆdataset;
output file = ˆoutfile;
load x = ˆdatafile;
load path = ˆlpath x,y,z,t,w;
loadexe buf = ˆexefile;
save ˆname = x;
save path = ˆspath;
dos ˆcmdstr;
run ˆprog;
msym ˆmstring;
11-20
Operators
11.6
Using Dot Operators with Constants
When you use those operators preceded by a ‘.’ (dot operators) with a scalar integer constant,
insert a space between the constant and any following dot operator. Otherwise, the dot will be
interpreted as part of the scalar; that is, the decimal point. For example:
let y = 1 2 3;
x = 2.<y;
will return x as a scalar 0, not a vector of 0’s and 1’s, because
x = 2.<y;
is interpreted as
x = 2. < y;
and not as
Operators
x = 2 .< y;
Be careful when using the dot relational operators (.<, .<=, .= =, ./=, .>, .>=). The same
problem can occur with other dot operators, also. For example:
let x = 1 1 1;
y = x./2./x;
will return y as a scalar .5 rather than a vector of .5’s, because
11-21
GAUSS User Guide
y = x./2./x;
is interpreted as
y = (x ./ 2.) / x;
not
y = (x ./ 2) ./ x;
The second division, then, is handled as a matrix division rather than an element-by-element
division.
11.7
Operator Precedence
The order in which an expression is evaluated is determined by the precedence of the operators
involved and the order in which they are used. For example, the * and / operators have a higher
precedence than the + and − operators. In expressions that contain the above operators, the
operand pairs associated with the * or / operator are evaluated first. Whether * or / is evaluated
first depends on which comes first in the particular expression.
The expression
-5+3/4+6*3
is evaluated as
(-5)+(3/4)+(6*3)
11-22
Operators
Within a term, operators of equal precedence are evaluated from left to right. The precedence of
all operators, from the highest to the lowest, is listed in the following table:
Operator
.0
0
!
.ˆ
ˆ
(unary -)
*
*∼
.*
.*.
./
/
%
$+
+
-
Operator
.$>=
./=
.<
.<=
.= =
.>
.>=
.eq
.ge
.gt
.le
.lt
.ne
.not
.and
.or
.xor
.eqv
$/=
$<
$<=
$= =
$>
Precedence
65
65
65
65
65
65
65
65
65
65
65
65
65
64
63
62
61
60
55
55
55
55
55
Operator
$>=
/=
<
<=
==
>
>=
eq
ge
gt
le
lt
ne
not
and
or
xor
eqv
(space)
:
=
Precedence
55
55
55
55
55
55
55
55
55
55
55
55
55
49
48
47
46
45
35
35
10
Operators
∼
|
.$/=
.$<
.$<=
.$= =
.$>
Precedence
90
90
89
85
85
83
80
80
80
80
80
80
75
70
70
70
68
67
65
65
65
65
65
11-23
Procedures and Keywords
12
Procedures are multiple-line, recursive functions that can have either local or global variables.
Procedures allow a large computing task to be written as a collection of smaller tasks. These
smaller tasks are easier to work with and keep the details of their operation from the other parts of
the program that do not need to know them. This makes programs easier to understand and easier
to maintain.
A procedure in GAUSS is basically a user-defined function that can be used as if it were an
intrinsic part of the language. A procedure can be as small and simple or as large and complicated
as necessary to perform a particular task. Procedures allow you to build on your previous work
and on the work of others rather than starting over again and again to perform related tasks.
All labels and subroutines inside a procedure are local to that procedure and will not be confused
with labels of the same name in other procedures.
12-1
Procedures
Any intrinsic command or function may be used in a procedure, as well as any user-defined
function or other procedure. Procedures can refer to any global variable; that is, any variable in the
global symbol table that can be shown with the show command. It is also possible to declare local
variables within a procedure. These variables are known only inside the procedure they are defined
in and cannot be accessed from other procedures or from the main level program code.
GAUSS User Guide
12.1
Defining a Procedure
A procedure definition consists of five parts, four of which are denoted by explicit GAUSS
commands:
1.
2.
3.
4.
5.
Procedure declaration
Local variable declaration
Body of procedure
Return from procedure
End of procedure definition
proc statement
local statement
retp statement
endp statement
There is always one proc statement and one endp statement in a procedure definition. Any
statements that come between these two statements are part of the procedure. Procedure
definitions cannot be nested. local and retp statements are optional. There can be multiple
local and retp statements in a procedure definition. Here is an example:
proc (3) = regress(x, y);
local xxi,b,ymxb,sse,sd,t;
xxi = invpd(x’x);
b = xxi * (x’y);
ymxb = y-xb;
sse = ymxb’ymxb/(rows(x)-cols(x));
sd = sqrt(diag(sse*xxi));
t = b./sd;
retp(b,sd,t);
endp;
This could be used as a function that takes two matrix arguments and returns three matrices as a
result. For example: is:
{ b,sd,t } = regress(x,y);
Following is a discussion of the five parts of a procedure definition.
12-2
Procedures and Keywords
12.1.1
Procedure Declaration
The proc statement is the procedure declaration statement. The format is:
proc [[(rets) =]] name([[arg1,arg2,...argN]]);
rets
Optional constant, number of values returned by the procedure. Acceptable values here
are 0-1023; the default is 1.
name
Name of the procedure, up to 32 alphanumeric characters or an underscore, beginning
with an alpha or an underscore.
arg#
Names that will be used inside the procedure for the arguments that are passed to the
procedure when it is called. There can be 0-1023 arguments. These names will be
known only in the procedure being defined. Other procedures can use the same names,
but they will be separate entities.
12.1.2
Local Variable Declarations
The local statement is used to declare local variables. Local variables are variables known only
to the procedure being defined. The names used in the argument list of the proc statement are
always local. The format of the local statement is:
local x,y,f :proc,g:fn,z,h:keyword;
Variables that are global to the system (that is, variables listed in the global symbol table that can
be shown with the show command) can be accessed by any procedure without any redundant
declaration inside the procedure. If you want to create variables known only to the procedure
12-3
Procedures
Local variables can be matrices or strings. If :proc, :fn, or :keyword follows the variable name
in the local statement, the compiler will treat the symbol as if it were a procedure, function, or
keyword respectively. This allows passing procedures, functions, and keywords to other
procedures. (For more information, see P P  P, Section 12.4.
GAUSS User Guide
being defined, the names of these local variables must be listed in a local statement. Once a
variable name is encountered in a local statement, further references to that name inside the
procedure will be to the local rather than to a global having the same name. (See clearg, varget,
and varput in the GAUSS L R for ways of accessing globals from within
procedures that have locals with the same name.)
The local statement does not initialize (set to a value) the local variables. If they are not passed
in as parameters, they must be assigned some value before they are accessed or the program will
terminate with a Variable not initialized error message.
All local and global variables are dynamically allocated and sized automatically during execution.
Local variables, including those that were passed as parameters, can change in size during the
execution of the procedure.
Local variables exist only when the procedure is executing and then disappear. Local variables
cannot be listed with the show command.
The maximum number of locals is limited by stack space and the size of workspace memory. The
limiting factor applies to the total number of active local symbols at any one time during
execution. If cat has 10 locals and it calls dog which has 20 locals, there are 30 active locals
whenever cat is called.
There can be multiple local statements in a procedure. They will affect only the code in the
procedure that follows. Therefore, for example, it is possible to refer to a global x in a procedure
and follow that with a local statement that declares a local x. All subsequent references to x
would be to the local x. (This is not good programming practice, but it demonstrates the principle
that the local statement affects only the code that is physically below it in the procedure
definition.) Another example is a symbol that is declared as a local and then declared as a local
procedure or function later in the same procedure definition. This allows doing arithmetic on local
function pointers before calling them. (For more information, see I P, Section
12.5.
12.1.3
Body of Procedure
The body of the procedure can have any GAUSS statements necessary to perform the task the
procedure is being written for. Other user-defined functions and other procedures can be
referenced as well as any global matrices and strings.
12-4
Procedures and Keywords
GAUSS procedures are recursive, so the procedure can call itself as long as there is logic in the
procedure to prevent an infinite recursion. The process would otherwise terminate with either an
Insufficient workspace memory message or a Procedure calls too deep message,
depending on the space necessary to store the locals for each separate invocation of the procedure.
12.1.4
Returning from the Procedure
The return from the procedure is accomplished with the retp statement:
retp;
retp(expression1,expression2,. . .,expressionN);
The retp statement can have multiple arguments. The number of items returned must coincide
with the number of rets in the proc statement.
If the procedure was defined with no items returned, the retp statement is optional. The endp
statement that ends the procedure will generate an implicit retp with no objects returned. If the
procedure returns one or more objects, there must be an explicit retp statement.
There can be multiple retp statements in a procedure, and they can be anywhere inside the body
of the procedure.
12.1.5
End of Procedure Definition
The endp statement marks the end of the procedure definition:
An implicit retp statement that returns nothing is always generated here so it is impossible to run
off the end of a procedure without returning. If the procedure was defined to return one or more
objects, executing this implicit return will result in a Wrong number of returns error message
and the program will terminate.
12-5
Procedures
endp;
GAUSS User Guide
12.2
Calling a Procedure
Procedures are called like this:
dog(i,j,k);
/* no returns */
y = cat(i,j,k);
/* one return */
{ x,y,z } = bat(i,j,k);
/* multiple returns */
call bat(i,j,k);
/* ignore any returns */
Procedures are called in the same way that intrinsic functions are called. The procedure name is
followed by a list of arguments in parentheses. The arguments must be separated by commas.
If there is to be no return value, use
proc (0) = dog(x,y,z);
when defining the procedure and use
dog(ak,4,3);
or
call dog(ak,4,3);
when calling it.
The arguments passed to procedures can be complicated expressions involving calls to other
functions and procedures. This calling mechanism is completely general. For example,
12-6
Procedures and Keywords
y = dog(cat(3*x,bird(x,y))-2,2,1);
is legal.
12.3
Keywords
A keyword, like a procedure, is a subroutine that can be called interactively or from within a
GAUSS program. A keyword differs from a procedure in that a keyword accepts exactly one
string argument, and returns nothing. Keywords can perform many tasks not as easily
accomplished with procedures.
12.3.1
Defining a Keyword
A keyword definition is much like a procedure definition. Keywords always are defined with 0
returns and 1 argument. The beginning of a keyword definition is the keyword statement:
keyword name(strarg);
Name of the keyword, up to 32 alphanumeric characters or an underscore, beginning
with an alpha or an underscore.
strarg
Name that will be used inside of the keyword for the argument that is passed to the
keyword when it is called. There is always one argument. The name is known only in
the keyword being defined. Other keywords can use the same name, but they will be
separate entities. This will always be a string. If the keyword is called with no
characters following the name of the keyword, this will be a null string.
The rest of the keyword definition is the same as a procedure definition. (For more information,
see D  P, Section 12.1. Keywords always return nothing. Any retp statements,
if used, should be empty. For example:
12-7
Procedures
name
GAUSS User Guide
keyword add(s);
local tok, sum;
if s $=\,= "";
print "The argument is a null string";
retp;
endif;
print "The argument is: ’" s "’";
sum = 0;
do until s $=\,= "";
{ tok, s } = token(s);
sum = sum + stof(tok);
endo;
format /rd 1,2;
print "The sum is:
" sum;
endp;
The keyword defined above will print the string argument passed to it. The argument will be
printed enclosed in single quotes.
12.3.2
Calling a Keyword
When a keyword is called, every character up to the end of the statement, excluding the leading
spaces, is passed to the keyword as one string argument. For example, if you type
add 1 2 3 4 5;
the keyword will respond
The sum is:
12-8
15.00
Procedures and Keywords
Here is another example:
add;
the keyword will respond
The argument is a null string
12.4
Passing Procedures to Procedures
Procedures and functions can be passed to procedures in the following way:
proc max(x,y); /* procedure to return maximum */
if x>y;
retp(x);
else;
retp(y);
endif;
endp;
fn lgsqrt(x) = ln(sqrt(x));
Procedures
proc min(x,y); /* procedure to return minimum */
if x<y;
retp(x);
else;
retp(y);
endif;
endp;
/* function to return
:: log of square root
*/
12-9
GAUSS User Guide
proc myproc(&f1,&f2,x,y);
local f1:proc, f2:fn, z;
z = f1(x,y);
retp(f2(z));
endp;
The procedure myproc takes four arguments. The first is a procedure f1 that has two arguments.
The second is a function f2 that has one argument. It also has two other arguments that must be
matrices or scalars. In the local statement, f1 is declared to be a procedure and f2 is declared to
be a function. They can be used inside the procedure in the usual way. f1 will be interpreted as a
procedure inside myproc, and f2 will be interpreted as a function. The call to myproc is made as
follows:
k = myproc(&max,&lgsqrt,5,7);
/* log of square root of 7 */
k = myproc(&min,&lgsqrt,5,7);
/* log of square root of 5 */
The ampersand (&) in front of the function or procedure name in the call to myproc causes a
pointer to the function or procedure to be passed. No argument list should follow the name when it
is preceded by the ampersand.
Inside myproc, the symbol that is declared as a procedure in the local statement is assumed to
contain a pointer to a procedure. It can be called exactly like a procedure is called. It cannot be
save’d but it can be passed on to another procedure. If it is to be passed on to another procedure,
use the ampersand in the same way.
12.5
Indexing Procedures
This example assumes there are a set of procedures named f1-f5 that are already defined. A 1×5
vector procvec is defined by horizontally concatenating pointers to these procedures. A new
procedure, g(x,i) is then defined to return the value of the ith procedure evaluated at x:
procvec = &f1 ˜ &f2 ˜ &f3 ˜ &f4 ˜ &f5;
12-10
Procedures and Keywords
proc g(x,i);
local f;
f = procvec[i];
local f:proc;
retp( f(x) );
endp;
The local statement is used twice. The first time, f is declared to be a local matrix. After f has
been set equal to the ith pointer, f is declared to be a procedure and is called as a procedure in the
retp statement.
12.6
Multiple Returns from Procedures
Procedures can return multiple items, up to 1023. The procedure is defined like this example of a
complex inverse:
proc (2) = cminv(xr,xi); /* (2) specifies number of
:: return values
*/
local ixy, zr, zi;
ixy = inv(xr)*xi;
zr = inv(xr+xi*ixy); /* real part of inverse. */
zi = -ixy*zr;
/* imaginary part of inverse. */
retp(zr,zi);
/* return: real part, imaginary part */
endp;
Procedures
It can then be called like this:
{ zr,zi } = cminv(xr,xi);
To make the assignment, the list of targets must be enclosed in braces.
12-11
GAUSS User Guide
Also, a procedure that returns more than one argument can be used as input to another procedure
or function that takes more than one argument:
proc (2) = cminv(xr,xi);
local ixy, zr, zi;
ixy = inv(xr)*xi;
zr = inv(xr+xi*ixy);
zi = -ixy*zr;
retp(zr,zi);
endp;
/* real part of inverse. */
/* imaginary part of inverse. */
proc (2) = cmmult(xr,xi,yr,yi);
local zr,zi;
zr = xr*yr-xi*yi;
zi = xr*yi+xi*yr;
retp(zr,zi);
endp;
{ zr,zi } = cminv( cmmult(xr,xi,yr,yi) );
The two returned matrices from cmmult() are passed directly to cminv() in the statement above.
This is equivalent to the following statements:
{ tr,ti } = cmmult(xr,xi,yr,yi);
{ zr,zi } = cminv(tr,ti);
This is completely general so the following program is legal:
proc (2) = cmcplx(x);
local r,c;
r = rows(x);
c = cols(x);
retp(x,zeros(r,c));
endp;
12-12
Procedures and Keywords
proc (2) = cminv(xr,xi);
local ixy, zr, zi;
ixy = inv(xr)*xi;
zr = inv(xr+xi*ixy);
zi = -ixy*zr;
retp(zr,zi);
endp;
/* real part of inverse. */
/* imaginary part of inverse. */
proc (2) = cmmult(xr,xi,yr,yi);
local zr,zi;
zr = xr*yr-xi*yi;
zi = xr*yi+xi*yr;
retp(zr,zi);
endp;
{ xr,xi } = cmcplx(rndn(3,3));
{ yr,yi } = cmcplx(rndn(3,3));
{ zr,zi } = cmmult( cminv(xr,xi),cminv(yr,yi) );
{ qr,qi } = cmmult( yr,yi,cminv(yr,yi) );
{ wr,wi } = cmmult(yr,yi,cminv(cmmult(cminv(xr,xi),yr,yi)));
12.7
Saving Compiled Procedures
If a procedure contains no global references, that is, if it does not reference any global matrices or
strings and it does not call any user-defined functions or procedures, it can be saved to disk in
compiled form in a .fcg file with the save command, and loaded later with the loadp command
12-13
Procedures
When a file containing a procedure definition is run, the procedure is compiled and is then resident
in memory. The procedure can be called as if it were an intrinsic function. If the new command is
executed or you quit GAUSS and exit to the operating system, the compiled image of the
procedure disappears and the file containing the procedure definition will have to be compiled
again.
GAUSS User Guide
whenever it is needed. This will usually be faster than recompiling. For example:
save path = c:\gauss\cp proc1,proc2,proc3;
loadp path = c:\gauss\cp proc1,proc2,proc3;
The name of the file will be the same as the name of the procedure, with a .fcg extension. (For
details, see loadp and save in the GAUSS L R.)
All compiled procedures should be saved in the same subdirectory, so there is no question where
they are located when it is necessary to reload them. The loadp path can be set in your startup file
to reflect this. Then, to load in procedures, use
loadp proc1,proc2,proc3;
Procedures that are saved in .fcg files will NOT be automatically loaded. It is necessary to
explicitly load them with loadp. This feature should be used only when the time necessary for the
autoloader to compile the source is too great. Also, unless these procedures have been compiled
with #lineson, debugging will be more complicated.
12-14
Sparse
Matrices
Sparse Matrices
13
The sparse matrix data type stores only the non-zero values of a 2-dimensional sparse matrix,
which makes working with sparse matrices faster and more efficient.
13.1
Defining Sparse Matrices
The sparse matrix data type is strongly typed in GAUSS, which means that a variable must be
defined as a sparse matrix variable before it may be used as such. Once a variable has been defined
as a sparse matrix, it may not be used as another data type. Similarly, once a variable has been
used as a matrix, array, or other non-sparse data type, it may not be redefined as a sparse matrix.
To define a global sparse matrix, you may use either the declare or the let command:
declare sparse matrix sm1;
or
13-1
GAUSS User Guide
let sparse matrix sm1;
or the following implicit let statement:
sparse matrix sm1;
declare may be used to define multiple sparse matrices in a single statement:
declare sparse matrix sm1, sm2, sm3;
To define a local sparse matrix inside of a procedure, use an implicit let statement:
sparse matrix lsm1;
As neither let nor declare support the initialization of a sparse matrix at this time, you must
initialize a sparse matrix with an assigment after defining it.
13.2
Creating and Using Sparse Matrices
Several new functions have been added to allow you to create and manipulate sparse matrices.
These functions are:
13-2
denseToSp
Converts a dense matrix to a sparse matrix.
denseToSpRE
Converts a dense matrix to a sparse matrix, using a relative epsilon.
packedToSp
Creates a sparse matrix from a packed matrix of non-zero values and
row and column indices.
spCreate
Creates a sparse matrix from vectors of non-zero values, row
indices, and column indices.
spDenseSubmat
Returns a dense submatrix of sparse matrix.
spDiagRvMat
Inserts submatrices along the diagonal of a sparse matrix.
spEye
Creates a sparse identity matrix.
spGetNZE
Returns the non-zero values in a sparse matrix, as well as their
corresponding row and column indices.
spNumNZE
Returns the number of non-zero elements in a sparse matrix.
spOnes
Generates a sparse matrix containing only ones and zeros
spSubmat
Returns a sparse submatrix of sparse matrix.
spToDense
Converts a sparse matrix to a dense matrix.
spTrTDense
Multiplies a sparse matrix transposed by a dense matrix.
spTScalar
Multiplies a sparse matrix by a scalar.
spZeros
Creates a sparse matrix containing no non-zero values.
See C R, Chapter 31, for detailed information on each command.
13.3
Sparse Support in Matrix Functions and Operators
Support for the sparse matrix data type has also been added to many matrix functions and
operators. The following is a complete list of the matrix functions and operators that currently
support the new sparse matrix type:
0
∼
|
*
.*
+
-
/
./
/=
./=
==
.= =
>
13-3
Sparse
Matrices
Sparse Matrices
GAUSS User Guide
.>
>=
.>=
<
.<
<=
.<=
abs
cols
maxc
minc
print
rows
scalerr
show
type
Indexing is also supported for sparse matrices, using the same syntax as matrix indexing.
Note that printing a sparse matrix results in a table of the non-zero values contained in the sparse
matrix, followed by their corresponding row and column indices, respectively.
13.3.1
Return Types for Dyadic Operators
The types of the returns for the dyadic operators were decided on a case-by-case basis, using the
following general principles:
1. The return type for dyadic operations on two dense arguments is always dense.
2. The return type for dyadic operations on two sparse arguments is always sparse unless the
result is likely to be significantly less sparse than the sparse arguments.
3. The return type for dyadic operations on a dense argument and a sparse argument (regardless
of order) is dense unless the return is likely to be at least as sparse as the sparse argument.
These general principles have led to the following decisions regarding return types (note that only
the cases that are displayed in these tables have been implemented at this point):
13-4
Element-by-Element Numeric Operators
Element-by-Element Addition
Result =
Left
Operator Right
dense = sparse
+
dense
dense = dense
+
dense
sparse = sparse
+
sparse
dense = dense
+
sparse
Element-by-Element Subtraction
Result =
Left
Operator Right
dense = sparse
dense
dense = dense
dense
sparse = sparse
sparse
dense = dense
sparse
Element-by-Element Multiplication
Result =
Left
Operator Right
sparse = sparse
.*
dense
dense = dense
.*
dense
sparse = sparse
.*
sparse
sparse = dense
.*
sparse
Element-by-Element Division
Result =
Left
Operator Right
sparse = sparse
./
dense
dense = dense
./
dense
dense = sparse
./
sparse
dense = dense
./
sparse
13-5
Sparse
Matrices
Sparse Matrices
GAUSS User Guide
Other Numeric Operators
Result
dense
dense
sparse
Matrix Multiplication
=
Left
Operator
= sparse
*
= dense
*
= sparse
*
Right
dense
dense
sparse
Result
dense
dense
Linear Solve
Left Operator
dense
/
dense
/
Right
dense
sparse
=
=
=
Note that at this time, the dense = dense / sparse case is defined only for real data.
When either of its arguments are sparse, the / operator uses a tolerance to determine the result,
which may be read or set using the sysstate function, case 39. The default tolerance is 1e-14.
Relational Operators
Since the results of element-by-element ’dot’ comparison operators depend largely on the kind of
data inputted, there are both both dense-returning and sparse-returning versions of the dot
comparison operators when one or both arguments is a sparse matrix. The regular dot comparison
operators and their alphabetic counterparts always return dense matrices, and there is a new set of
alphabetic dot comparison operators that all return sparse matrices:
Element-by-Element Dot Comparison Operators
Operation
Dense-Returning Sparse-Returning
Equal to
.= =
.eq
.speq
Not equal to
./=
.ne
.spne
Less than
.<
.lt
.splt
Less than or equal to
.<=
.le
.sple
Greater than
.>
.gt
.spgt
Greater than or equal to .>=
.ge
.spge
13-6
Since the element-by-element ’non-dot’ comparison operators (= =, /=, <, <=, >, >=) and their
alphabetic counterparts (eq, ne, lt, le, gt, ge) all return scalars, there are no sparse-returning
versions of them.
Other Matrix Operators
Result
dense
sparse
Horizontal Concatenation
=
Left
Operator Right
= dense
∼
dense
= sparse
∼
sparse
Result
dense
sparse
Vertical Concatenation
=
Left
Operator Right
= dense
|
dense
= sparse
|
sparse
13-7
Sparse
Matrices
Sparse Matrices
14
In GAUSS, internally, matrices and arrays are separate data types. Matrices, which are
2-dimensional objects, are stored in memory in row major order. Therefore, a 3×2 matrix is stored
as follows:
[1, 1] [1, 2] [2, 1] [2, 2] [3, 1] [3, 2]
The slowest moving dimension in memory is indexed on the right, and the fastest moving
dimension is indexed on the left. This is true of N-dimensional arrays as well. A 4×3×2 array is
stored in the following way:
[1, 1, 1]
[2, 1, 1]
[3, 1, 1]
[4, 1, 1]
[1, 1, 2]
[2, 1, 2]
[3, 1, 2]
[4, 1, 2]
[1, 2, 1]
[2, 2, 1]
[3, 2, 1]
[4, 2, 1]
[1, 2, 2]
[2, 2, 2]
[3, 2, 2]
[4, 2, 2]
[1, 3, 1]
[2, 3, 1]
[3, 3, 1]
[4, 3, 1]
[1, 3, 2]
[2, 3, 2]
[3, 3, 2]
[4, 3, 2]
A complex N-dimensional array is stored in memory in the same way. Like complex matrices,
complex arrays are stored with the entire real part first, followed by the entire imaginary part.
14-1
Arrays
N-Dimensional Arrays
GAUSS User Guide
Every N-dimensional array has a corresponding N×1 vector of orders that contains the sizes of
each dimension of the array. This is stored with the array and can be accessed with getorders.
The first element of the vector of orders corresponds to the slowest moving dimension, and the last
element corresponds to the fastest moving dimension (refer to the sectionnameGlossary of Terms
at the end of the chapter for clear definitions of these terms). The vector of orders for a
6×5×4×3×2 array, which has 5 dimensions, is the following 5×1 vector:
6
5
4
3
2
Two terms that are important in working with N-dimensional arrays are “dimension index” and
“dimension number.” A dimension index specifies a dimension based on indexing the vector of
orders. It is a scalar, 1-to-N, where 1 corresponds to the dimension indicated by the first element
of the vector of orders of the array (the slowest moving dimension) and N corresponds to the
dimension indicated by the last element of the vector of orders (the fastest moving dimension).
A dimension number specifies dimensions by numbering them in the same order that one would
add dimensions to an array. In other words, the dimensions of an N-dimensional array are
numbered such that the fastest moving dimension has a dimension number of 1, and the slowest
moving dimension has a dimension number of N.
A 6×5×4×3×2 array has 5 dimensions, so the first element of the vector of orders (in this case, 6)
refers to the size of dimension number 5. Since the index of this element in the vector of orders is
1, the dimension index of the corresponding dimension (dimension number 5) is also 1.
You will find references to both dimension index and dimension number in the documentation for
the functions that manipulate arrays.
There are a number of functions that have been designed to manipulate arrays. These functions
allow you to manipulate a subarray within the array by passing in a locator vector to index any
subarray that comprises a contiguous block of memory within the larger block. A vector of indices
of an N-dimensional array is a [1-to-N]×1 vector of base 1 indices into the array, where the first
element corresponds to the first element in a vector of orders. An N×1 vector of indices locates the
14-2
N-Dimensional Arrays
scalar whose position is indicated by the indices. For a 4×3×2 array x, the 3×1 vector of indices:
Arrays
3
2
1
indexes the [3,2,1] element of x. A 2×1 vector of indices for this 3-dimensional example,
references the 1-dimensional array whose starting location is given by the indices.
Because the elements of the vector of indices are always in the same order (the first element of the
vector of indices corresponds to the slowest moving dimension of the array, the second element to
the second slowest moving dimension, and so on), each unique vector of indices locates a unique
subarray.
In general, an [N-K]×1 vector of indices locates a K-dimensional subarray that begins at the
position indicated by the indices. The sizes of the dimensions of the K-dimensional subarray
correspond to the last K elements of the vector of orders of the N-dimensional array. For a
6×5×4×3×2 array y, the 2×1 vector of indices:
2
5
locates the 4×3×2 subarray in y that begins at [2,5,1,1,1] and ends at [2,5,4,3,2].
14.1
Bracketed Indexing
Brackets ‘[ ]’ can be used to index N-dimensional arrays in virtually the same way that they are
used to index matrices. Bracketed indexing is slower than the convenience array functions, such as
getarray and setarray; however, it can be used to index non-contiguous elements. In order to
index an N-dimensional array with brackets, there must be N indices located within the brackets,
where the first index corresponds to the slowest moving dimension of the array and the last index
corresponds to the fastest moving dimension.
14-3
GAUSS User Guide
For a 2×3×4 array x, such that
[1,1,1] through [1,3,4] =
1 2 3 4
5 6 7 8
9 10 11 12
[2,1,1] through [2,3,4] =
13 14 15 16
17 18 19 20
21 22 23 24
x[1,2,3] returns a 1×1×1 array containing the [1,2,3] element of x:
7
x[.,3,2] returns a 2×1×1 array containing
10
22
x[2,.,1 4] returns a 1×3×2 array containing
13 16
17 20
21 24
14-4
N-Dimensional Arrays
x[.,2,1:3] returns a 2×1×3 array containing
5
6
7
Arrays
17 18 19
14.2
E×E Conformability
The following describes rules for E×E conformability of arrays for operators and functions with
two or more arguments.
• Any N-dimensional array is conformable to a scalar.
• An array is conformable to a matrix only if the array has fewer than 3 dimensions, and the
array and matrix follow the standard rules of E×E conformability.
• Two arrays are E×E conformable if they comply with one of the following requirements:
– The two arrays have the same number of dimensions, and each dimension has the same
size.
– The two arrays have the same number of dimensions, and each of the N-2 slowest
moving dimensions has the same size. In this case, the 2 fastest moving dimensions of
the arrays must follow the E×E comformability rules that apply to matrices.
– Both of the arrays have fewer than 3 dimensions, and they follow the E×E
conformability rules that apply to matrices.
14.3
Glossary of Terms
dimensions The number of dimensions of an object.
vector of orders N×1 vector of the sizes of the dimensions of an object, where N is the
number of dimensions, and the first element corresponds to the slowest moving
dimension.
14-5
GAUSS User Guide
vector of indices [1-to-N]×1 vector of indices into an array, where the first element
corresponds to the first element in a vector of orders.
dimension number Scalar [1-to-N], where 1 corresponds to the fastest moving dimension
and N to the slowest moving dimension.
dimension index Scalar [1-to-N], where 1 corresponds to the first element of the vector of
orders or vector of indices.
locator [1-to-N]×1 vector of indices into an array used by array functions to locate a
contiguous block of the array.
14-6
Working with Arrays
Initializing Arrays
The use of N-dimensional arrays in GAUSS is an additional tool for reducing development time
and increasing execution speed of programs. There are multiple ways of handling N-dimensional
arrays and using them to solve problems, and these ways sometimes have implications for a
trade-off between speed of execution and development time. We will try to make this clear in this
chapter.
The term “arrays” specifically refers to N-dimensional arrays and must not be confused with
matrices. Matrices and arrays are distinct types even if in fact they contain identical information.
Functions for conversion from one to the other are described below.
There are five basic ways of creating an array depending on how the contents are specified:
areshape
Create array from specified matrix .
aconcat
Create array from matrices and arrays.
aeye
Create array of identity matrices.
15-1
Working
with Arrays
15.1
15
GAUSS User Guide
arrayinit
Allocate array filled with specified scalar value.
arrayalloc
Allocate array with no specified contents.
15.1.1
areshape
areshape is a method for creating an array with specified contents. arrayinit creates an array
filled with a selected scalar value: areshape will do the same, but with a matrix. For example,
given a matrix, areshape will create an array containing multiple copies of that matrix:
x = reshape(seqa(1,1,4),2,2);
ord = 3 | 2 | 2;
a = areshape(x,ord);
print a;
Plane [1,.,.]
1.0000 2.0000
3.0000 4.0000
Plane [2,.,.]
1.0000 2.0000
3.0000 4.0000
Plane [3,.,.]
1.0000 2.0000
3.0000 4.0000
Reading Data from the Disk into an Array
areshape is a fast way to re-dimension a matrix or array already in memory. For example,
suppose we have a GAUSS data set containing panel data and that it’s small enough to be read in
all at once:
15-2
Working with Arrays
panel = areshape(loadd("panel"),5|100|10);
mn = amean(panel,2); /* 5x1x10 array of means */
/*of each panel */
mm = moment(panel,0); /* 5x10x10 array of moments */
/* of each panel */
/*
** vc is a 5x10x10 array of
** covariance matrices
*/
vc = mm / 100 - amult(atranspose(mn,1|3|2),mn);
Inserting Random Numbers into Arrays
A random array of any dimension or size can be quickly created using areshape. Thus, for a
10×10×5×3 array:
ord = { 10, 10, 5, 3 };
y = areshape(rndu(prodc(ord),1),ord);
The quick and dirty method above uses the linear congruential generator, which is fast but doesn’t
have the properties required for serious Monte Carlo work. For series simulation you will need to
use the KM generator:
sd0 = 345678;
ord = { 10, 10, 5, 3 };
{ z,sd0 } = rndKMu(prodc(ord),1,sd0);
y = areshape(z,ord);
15-3
Working
with Arrays
panel is a 5×100×10 array, and in this context is 5 panels of 100 cases measured on 10 variables.
GAUSS User Guide
Expanding a Matrix into an Array Vector of Matrices
For computing the log-likelihood of a variance components model of panel data, it is necessary to
expand a T×T matrix into an NT×T array of these matrices. This is easily accomplished using
areshape. For example:
m = { 1.0 0.3 0.2,
0.3 1.0 0.1,
0.2 0.1 1.0 };
r = areshape(m,3|3|3);
print r;
Plane [1,.,.]
1.0000
0.3000
0.2000
0.3000
1.0000
0.1000
0.2000
0.1000
1.0000
Plane [2,.,.]
1.0000
0.3000
0.2000
0.3000
1.0000
0.1000
0.2000
0.1000
1.0000
Plane [3,.,.]
1.0000
0.3000
0.2000
15.1.2
0.3000
1.0000
0.1000
0.2000
0.1000
1.0000
aconcat
aconcat creates arrays from conformable sets of matrices or arrays. With this function, contents
are completely specified by the user. This example tries three concatenations, one along each
15-4
Working with Arrays
dimension:
rndseed 345678;
x1 = rndn(2,2);
x2 = arrayinit(2|2,1);
/*
** along the first dimension or rows
*/
Working
with Arrays
a = aconcat(x1,x2,1);
print a;
-0.4300 -0.2878 1.0000 1.0000
-0.1327 -0.0573 1.0000 1.0000
/*
** along the second dimension or columns
*/
a = aconcat(x1,x2,2);
print a;
-0.4300 -0.2878
-0.1327 -0.0573
1.0000 1.0000
1.0000 1.0000
/*
** along the third dimension
*/
a = aconcat(x1,x2,3);
print a;
Plane [1,.,.]
15-5
GAUSS User Guide
-0.4300 -0.2878
-0.1327 -0.0573
Plane [2,.,.]
1.0000 1.0000
1.0000 1.0000
15.1.3
aeye
aeye creates an array in which the principal diagonal of the two trailing dimensions is set to one.
For example:
ord = 2 | 3 | 3;
a = aeye(ord);
print a;
Plane [1,.,.]
1.00000 0.00000 0.00000
0.00000 1.00000 0.00000
0.00000 0.00000 1.00000
Plane [2,.,.]
1.00000 0.00000 0.00000
0.00000 1.00000 0.00000
0.00000 0.00000 1.00000
15.1.4
arrayinit
arrayinit creates an array with all elements set to a specified value. For example:
ord = 3 | 2 | 3;
15-6
Working with Arrays
a = arrayinit(ord,1);
print a;
Plane [1,.,.]
1.0000 1.0000 1.0000
1.0000 1.0000 1.0000
Plane [2,.,.]
Working
with Arrays
1.0000 1.0000 1.0000
1.0000 1.0000 1.0000
Plane [3,.,.]
1.0000 1.0000 1.0000
1.0000 1.0000 1.0000
15.1.5
arrayalloc
arrayalloc creates an array with specified number and size of dimensions without setting
elements to any values. This requires a vector specifying the order of the array. The length of the
vector determines the number of dimensions, and each element determines the size of the
corresponding dimensions. The array will then have to be filled using any of several methods
described later in this chapter.
For example, to allocate a 2×2×3 array:
rndseed 345678;
ord = 3 | 2 | 2;
a = arrayalloc(ord,0);
for i(1,ord[1],1);
a[i,.,.] = rndn(2,3);
endfor;
15-7
GAUSS User Guide
print a;
Plane [1,.,.]
-0.4300 -0.2878 -0.1327
-0.0573 -1.2900 0.2467
Plane [2,.,.]
-1.4249 -0.0796 1.2693
-0.7530 -1.7906 -0.6103
Plane [3,.,.]
1.2586 -0.4773 0.7044
-1.2544 0.5002 0.3559
The second argument in the call to arrayalloc specifies whether the created array is real or
complex. arrayinit creates only real arrays.
15.2
Assigning to Arrays
There are three methods used for assignment to an array:
index operator
The same method as matrices, generalized to arrays.
putArray
Put a subarray into an N-dimensional array and returns the result.
setArray
Set a subarray of an N-dimensional array in place.
And there are several ways to extract parts of arrays:
index operator
15-8
The same method as matrices, generalized to arrays.
Working with Arrays
getArray
Get a subarray from an array.
getMatrix
Get a matrix from an array.
getMatrix4D
Get a matrix from a 4-dimensional array.
getScalar3D
Get a scalar from a 3-dimensional array.
getScalar4D
Get a scalar from a 4-dimensional array.
15.2.1
index operator
The index operator will put a subarray into an array in a manner analogous to the use of index
operators on matrices:
a = arrayinit(3|2|2,0);
b = arrayinit(3|1|2,1);
a[.,2,.] = b;
print a;
Plane [1,.,.]
0.00000 0.00000
1.0000 1.0000
Plane [2,.,.]
0.00000 0.00000
1.0000 1.0000
Plane [3,.,.]
15-9
Working
with Arrays
The index operator is the slowest way to extract parts of arrays. The specialized functions are the
fastest when the circumstances are appropriate for their use.
GAUSS User Guide
0.00000 0.00000
1.0000 1.0000
As this example illustrates, the assignment doesn’t have to be contiguous. putMatrix and
setMatrix require a contiguous assignment, but for that reason they are faster.
The right hand side of the assignment can also be a matrix:
a[1,.,.] = rndn(2,2);
print a;
Plane [1,.,.]
-1.7906502 -0.61038103
1.2586160 -0.47736360
Plane [2,.,.]
0.00000 0.00000
1.00000 1.00000
Plane [3,.,.]
0.00000 0.00000
1.00000 1.00000
The index operator will extract an array from a subarray in a manner analogous to the use of index
operators on matrices:
a = areshape(seqa(1,1,12),3|2|2);
b = a[.,1,.];
print a;
Plane [1,.,.]
15-10
Working with Arrays
1.0000 2.0000
3.0000 4.0000
Plane [2,.,.]
5.0000 6.0000
7.0000 8.0000
Plane [3,.,.]
Working
with Arrays
9.0000 10.000
11.000 12.000
print b;
Plane [1,.,.]
1.0000 2.0000
Plane [2,.,.]
5.0000 6.0000
Plane [3,.,.]
9.0000 10.000
It is important to note that the result is always an array even if it’s a scalar value:
c = a[1,1,1];
print c;
Plane [1,.,.]
15-11
GAUSS User Guide
1.0000
If you require a matrix result, and if the result has one or two dimensions, use arraytomat to
convert to a matrix, or use getMatrix, getMatrix3D, or getMatrix4D. Or, if the result is a
scalar, use getScalar3D or getScalar4D.
15.2.2
getArray
getArray is an additional method for extracting arrays:
a = areshape(seqa(1,1,12),3|2|2);
b = getarray(a,2|1);
print a;
Plane [1,.,.]
1.0000 2.0000
3.0000 4.0000
Plane [2,.,.]
5.0000 6.0000
7.0000 8.0000
Plane [3,.,.]
9.0000 10.000
11.000 12.000
print b;
5.0000 6.0000
getArray can only extract a contiguous part of an array. To get non-contiguous parts you must
use the index operator.
15-12
Working with Arrays
15.2.3
getMatrix
If the result is one or two dimensions, getMatrix returns a portion of an array converted to a
matrix. getMatrix is about 20 percent faster than the index operator:
a = areshape(seqa(1,1,12),3|2|2);
b = getMatrix(a,2);
print b;
15.2.4
Working
with Arrays
5.0000 6.0000
7.0000 8.0000
getMatrix4D
This is a specialized version of getMatrix for 4-dimensional arrays. It behaves just like
getMatrix but is dramatically faster for that type of array. The following illustrates the difference
in timing:
a = arrayinit(100|100|10|10,1);
t0 = date;
for i(1,100,1);
for j(1,100,1);
b = a[i,j,.,.];
endfor;
endfor;
t1 = date;
e1 = ethsec(t0,t1);
print e1;
print;
t2=date;
for i(1,100,1);
15-13
GAUSS User Guide
for j(1,100,1);
b = getMatrix4d(a,i,j);
endfor;
endfor;
t3 = date;
e2 = ethsec(t2,t3);
print e2;
print;
print ftostrC(100*((e1-e2)/e1),
"percent difference - %6.2lf%%");
13.000000
5.0000000
percent difference - 61.54%
15.2.5
getScalar3D, getScalar4D
These are specialized versions of getMatrix for retrieving scalar elements of 3-dimensional and
4-dimensional arrays, respectively. They behave just like getMatrix, with scalar results, but are
much faster. For example:
a = arrayinit(100|10|10,1);
t0 = date;
for i(1,100,1);
for j(1,10,1);
for k(1,10,1);
b = a[i,j,k];
endfor;
endfor;
endfor;
15-14
Working with Arrays
t1 = date;
e1 = ethsec(t0,t1);
print e1;
print;
t2=date;
Working
with Arrays
for i(1,100,1);
for j(1,10,1);
for k(1,10,1);
b = getscalar3d(a,i,j,k);
endfor;
endfor;
endfor;
t3 = date;
e2 = ethsec(t2,t3);
print e2;
print;
print ftostrC(100*((e1-e2)/e1),
"percent difference - %6.2lf%%");
7.0000000
2.0000000
percent difference - 71.43%
15.2.6
putArray
putArray enters a subarray, matrix, or scalar into an N-dimensional array and returns the result in
an array. This function is much faster than the index operator, but it requires the part of the array
being assigned to be contiguous:
a = arrayinit(3|2|2,3);
b = putarray(a,2,eye(2));
15-15
GAUSS User Guide
print b;
Plane [1,.,.]
3.0000 3.0000
3.0000 3.0000
Plane [2,.,.]
1.0000 0.00000
0.00000 1.0000
Plane [3,.,.]
3.0000 3.0000
3.0000 3.0000
15.2.7
setArray
setArray enters a subarray, matrix, or scalar into an N-dimensional array in place:
a = arrayinit(3|2|2,3);
setarray a,2,eye(2);
print b;
Plane [1,.,.]
3.0000 3.0000
3.0000 3.0000
Plane [2,.,.]
1.0000 0.0000
0.0000 1.0000
15-16
Working with Arrays
Plane [3,.,.]
3.0000 3.0000
3.0000 3.0000
15.3
Looping with Arrays
yord
xord
gord
aord
=
=
=
=
getOrders(Y);
getOrders(X);
getOrders(phi);
getOrders(theta);
N = yord[1]; /*
L = yord[3]; /*
K = xord[3]; /*
/*
P = gord[1]; /*
Q = aord[1]; /*
No. of observations */
No. of time series */
No. of independent variables */
in mean equation */
order of garch parameters */
order of arch parameters */
r = maxc(P|Q);
E = Y - amult(X,areshape(B,N|K|L));
sigma = areshape(omega,N|L|L);
for i(r+1,N,1);
for j(1,Q,1);
W = amult(theta[j,.,.],
atranspose(E[i-j,.,.],1|3|2));
sigma[i,.,.] = sigma[i,.,.] + amult(W,atranspose(W,1|3|2));
15-17
Working
with Arrays
When working with arrays, for loops and do loops may be used in the usual way. In the
following, let Y be an N×1×L array of L time series, X an N×1×K array of K independent
variables, B a K×L matrix of regression coefficients, phi a P×L×L array of garch coefficients,
theta a Q×L×L array of arch coefficients, and omega a L×L symmetric matrix of constants. The
log-likelihood for a multivariate garch BEKK model can be computed using the index operator:
GAUSS User Guide
endfor;
for j(1,P,1);
sigma[i,.,.] = sigma[i,.,.] + amult(amult(phi[j,.,.],
sigma[i-j,.,.]),phi[j,.,.]);
endfor;
endfor;
sigmai = invpd(sigma);
lndet = ln(det(sigma));
lnl = -0.5*( L*(N-R)*asum(ln(det(sigmai)),1) +
asum(amult(amult(E,sigmai),atranspose(E,1|3|2)),3);
Instead of index operators, the above computation can be done using getArray and setArray:
yord
xord
gord
aord
=
=
=
=
getOrders(Y);
getOrders(X);
getOrders(phi);
getOrders(theta);
N = yord[1]; /*
L = yord[3]; /*
K = xord[3]; /*
/*
P = gord[1]; /*
Q = aord[1]; /*
No. of observations */
No. of time series */
No. of independent variables */
in mean equation */
order of garch parameters */
order of arch parameters */
r = maxc(P|Q);
E = Y - amult(X,areshape(B,N|K|L));
sigma = areshape(omega,N|L|L);
for i(r+1,N,1);
for j(1,Q,1);
W = amult(getArray(theta,j),
atranspose(getArray(E,i-j),2|1));
setarray sigma,i,getArray(sigma,i)+
15-18
Working with Arrays
amult(W,atranspose(W,2|1));
endfor;
for j(1,P,1);
setarray sigma,i,getArray(sigma,i)+
areshape(amult(amult(getArray(phi,j),
getArray(sigma,i-j)),getArray(phi,j)),3|3);
endfor;
endfor;
Working
with Arrays
sigmai = invpd(sigma);
lndet = ln(det(sigma));
lnl = -0.5*( L*(N-R)*asum(ln(det(sigmai)),1)+
asum(amult(amult(E,sigmai),atranspose(E,1|3|2)),3)
Putting the two code fragments above into loops that called them a hundred times and measuring
the time, produced the following results:
index operator: 2.604 seconds
getArray, setArray: 1.092 seconds
Thus, the getArray and setArray methods are more than twice as fast.
15.3.1
loopnextindex
Several keyword functions are available in GAUSS for looping with arrays. The problem in the
previous section, for example, can be written using these functions rather than with for loops:
sigind = r + 1;
sigloop:
15-19
GAUSS User Guide
sig0ind = sigind[1];
thetaind = 1;
thetaloop:
sig0ind = sig0ind - 1;
W = amult(getArray(theta,thetaind),
atranspose(getArray(E,sig0ind),2|1));
setarray sigma,sigind,getArray(sigma,sigind)+
amult(W,atranspose(W,2|1));
loopnextindex thetaloop,thetaind,aord;
sig0ind = sigind;
phiind = 1;
philoop:
sig0ind[1] = sig0ind[1] - 1;
setarray sigma,sigind,getArray(sigma,sigind)+
areshape(amult(amult(getArray(phi,phiind),
getArray(sigma,sig0ind)),
getArray(phi,phiind)),3|3);
loopnextindex philoop,phiind,gord;
loopnextindex sigloop,sigind,sigord;
The loopnextindex function in this example isn’t faster than the for loop used in the previous
section primarily because the code is looping only through the first dimension in each loop. The
advantages of loopnextindex, previousindex, nextindex, and walkindex are when the
code is looping through the higher dimensions of a highly dimensioned array. In this case, looping
through an array can be very complicated and difficult to manage using for loops.
loopnextindex can be faster and more useful.
The next example compares two ways of extracting a subarray from a 5-dimensional array:
ord = 3|3|3|3|3;
a = areshape(seqa(1,1,prodc(ord)),ord);
b = eye(3);
for i(1,3,1);
15-20
Working with Arrays
for j(1,3,1);
for k(1,3,1);
setarray a,i|j|k,b;
endfor;
endfor;
endfor;
ind = { 1,1,1 };
loopi:
setarray a,ind,b;
loopnextindex loopi,ind,ord;
Working
with Arrays
Calling each loop 10,000 times and measuring the time each takes, we get
for loop: 1.171 seconds
loopnextindex: .321 seconds
In other words, loopnextindex is about four times faster, a very significant difference.
15.4
15.4.1
Miscellaneous Array Functions
atranspose
This function changes the order of the dimensions. For example:
a = areshape(seqa(1,1,12),2|3|2);
print a;
Plane [1,.,.]
15-21
GAUSS User Guide
1.0000 2.0000
3.0000 4.0000
5.0000 6.0000
Plane [2,.,.]
7.0000 8.0000
9.0000 10.000
11.000 12.000
/*
** swap 2nd and 3rd dimension
*/
print atranspose(a,1|3|2);
Plane [1,.,.]
1.0000 3.0000 5.0000
2.0000 4.0000 6.0000
Plane [2,.,.]
7.0000 9.0000 11.000
8.0000 10.000 12.000
/*
** swap 1st and 3rd dimension
*/
print atranspose(a,3|2|1);
Plane [1,.,.]
1.0000 7.0000
3.0000 9.0000
5.0000 11.000
15-22
Working with Arrays
Plane [2,.,.]
2.0000 8.0000
4.0000 10.000
6.0000 12.000
/*
** move 3rd into the front
*/
Working
with Arrays
print atranspose(a,3|1|2);
Plane [1,.,.]
1.0000 3.0000 5.0000
7.0000 9.0000 11.000
Plane [2,.,.]
2.0000 4.0000 6.0000
8.0000 10.000 12.000
15.4.2
amult
This function performs a matrix multiplication on the last two trailing dimensions of an array. The
leading dimensions must be strictly conformable, and the last two trailing dimensions must be
conformable in the matrix product sense. For example:
a = areshape(seqa(1,1,12),2|3|2);
b = areshape(seqa(1,1,16),2|2|4);
c = amult(a,b);
print a;
Plane [1,.,.]
15-23
GAUSS User Guide
1.0000 2.0000
3.0000 4.0000
5.0000 6.0000
Plane [2,.,.]
7.0000 8.0000
9.0000 10.000
11.000 12.000
print b;
Plane [1,.,.]
1.0000 2.0000 3.0000 4.0000
5.0000 6.0000 7.0000 8.0000
Plane [2,.,.]
9.0000 10.000 11.000 12.000
13.000 14.000 15.000 16.000
print c;
Plane [1,.,.]
11.000 14.000 17.000 20.000
23.000 30.000 37.000 44.000
35.000 46.000 57.000 68.000
Plane [2,.,.]
167.00 182.00 197.00 212.00
211.00 230.00 249.00 268.00
255.00 278.00 301.00 324.00
15-24
Working with Arrays
Suppose we have a matrix of data sets, a 2×2 matrix of 100×5 data sets that we’ve stored in a
2×2×100×5 array called x. The moment matrices of these data sets can easily and quickly be
computed using atranspose and amult:
vc = amult(atranspose(x,1|2|4|3),x);
15.4.3
amean, amin, amax
a = areshape(seqa(1,1,12),2|3|2);
print a;
Plane [1,.,.]
1.0000 2.0000
3.0000 4.0000
5.0000 6.0000
Plane [2,.,.]
7.0000 8.0000
9.0000 10.000
11.000 12.000
/*
** compute means along third dimension
*/
print amean(a,3);
Plane [1,.,.]
15-25
Working
with Arrays
These functions compute the means, minimums, and maximums, respectively, across a dimension
of an array. The size of the selected dimension of the resulting array is shrunk to one and contains
the means, minimums, or maximums depending on the function called. For example:
GAUSS User Guide
4.0000 5.0000
6.0000 7.0000
8.0000 9.0000
/*
** print means along the second dimension, i.e.,
** down the columns
*/
print amean(a,2);
Plane [1,.,.]
3.0000 4.0000
Plane [2,.,.]
9.0000 10.000
/*
** print the minimums down the columns
*/
print amin(a,2);
Plane [1,.,.]
1.0000 2.0000
Plane [2,.,.]
7.0000 8.0000
/*
** print the maximums along the third dimension
*/
15-26
Working with Arrays
print amax(a,3);
Plane [1,.,.]
7.0000 8.0000
9.0000 10.000
11.000 12.000
getDims
Working
with Arrays
15.4.4
This function returns the number of dimensions of an array:
a = arrayinit(4|4|5|2,0);
print getdims(a);
4.00
15.4.5
getOrders
This function returns the sizes of each dimension of an array. The length of the vector returned by
getOrders is the dimension of the array:
a = arrayinit(4|4|5|2,0);
print getOrders(a);
4.00
4.00
5.00
2.00
15-27
GAUSS User Guide
15.4.6
arraytomat
This function converts an array with two or fewer dimensions to a matrix:
a = arrayinit(2|2,0);
b = arraytomat(a);
type(a);
21.000
type(b);
6.0000
15.4.7
mattoarray
This function converts a matrix to an array:
b = rndn(2,2);
a = mattoarray(b);
type(b);
6.0000
type(a);
21.000
15.5
Using Arrays with GAUSS functions
Many of the GAUSS functions have been re-designed to work with arrays. There are two general
approaches to this implementation. There are exceptions, however, and you are urged to refer to
the documention if you are not sure how a particular GAUSS function handles array input.
15-28
Working with Arrays
In the first approach, the function returns an element-by-element result that is strictly conformable
to the input. For example, cdfnc returns an array of identical size and shape to the input array:
a = areshape(seqa(-2,.5,12),2|3|2);
b = cdfnc(a);
print b;
Plane [1,.,.]
Working
with Arrays
0.9772 0.9331
0.8413 0.6914
0.5000 0.3085
Plane [2,.,.]
0.1586 0.0668
0.0227 0.0062
0.0013 0.0002
In the second approach, which applies generally to GAUSS matrix functions, the function operates
on the matrix defined by the last two trailing dimensions of the array. Thus, given a 5×10×3 array,
moment returns a 5×3×3 array of five moment matrices computed from the five 10×3 matrices in
the input array.
Only the last two trailing dimensions matter; i.e., given a 2×3×4×5×10×6 array, moment returns a
2×3×4×5×6×6 array of moment matrices.
For example, in the following the result is a 2×3 array of 3×1 vectors of singular values of a 2×3
array of 6×3 matrices:
a = areshape(seqa(1,1,108),2|3|6|3);
b=svds(a);
print b;
15-29
GAUSS User Guide
Plane [1,1,.,.]
45.894532
1.6407053
1.2063156e-015
Plane [1,2,.,.]
118.72909
0.63421188
5.8652600e-015
Plane [1,3,.,.]
194.29063
0.38756064
1.7162751e-014
Plane [2,1,.,.]
270.30524
0.27857175
1.9012118e-014
Plane [2,2,.,.]
346.47504
0.21732995
1.4501098e-014
Plane [2,3,.,.]
422.71618
0.17813229
1.6612287e-014
It might be tempting to conclude from this example that, in general, a GAUSS function’s behavior
15-30
Working with Arrays
on the last two trailing dimensions of an array is strictly analogous to the GAUSS function’s
behavior on a matrix. This may be true with some of the functions, but not all. For example, the
GAUSS meanc function returns a column result for matrix input. However, the behavior for the
GAUSS amean function is not analogous. This function takes a second argument that specifies on
which dimension the mean is to be taken. That dimension is then collapsed to a size of 1. Thus:
a = areshape(seqa(1,1,24),2|3|4);
print a;
Plane [1,.,.]
Working
with Arrays
1.000 2.000 3.000 4.000
5.000 6.000 7.000 8.000
9.000 10.000 11.000 12.000
Plane [2,.,.]
13.000 14.000 15.000 16.000
17.000 18.000 19.000 20.000
21.000 22.000 23.000 24.000
/*
** means computed across rows
*/
b = amean(a,1);
print b;
Plane [1,.,.]
2.500
6.500
10.500
Plane [2,.,.]
14.500
15-31
GAUSS User Guide
18.500
22.500
/*
** means computed down columns
*/
c = amean(a,2);
print c;
Plane [1,.,.]
5.000
6.000
7.000
8.000
Plane [2,.,.]
17.000 18.000 19.000 20.000
/*
** means computed along 3rd dimension
*/
d = amean(a,3);
print d;
Plane [1,.,.]
7.000 8.000 9.000 10.000
11.000 12.000 13.000 14.000
15.000 16.000 17.000 18.000
15.6
A Panel Data Model
Suppose we have N cases observed at T times. Let yit be an observation on a dependent variable
for the ith case at time t, Xit an observation of k independent variables for the ith case at time t, B, a
15-32
Working with Arrays
K×1 vector of coefficients. Then
yit = Xit B + µi + it
is a variance components model where µi is a random error term uncorrelated with it , but which is
correlated within cases. This implies an NT×NT residual moment matrix that is block diagonal
with N T×T moment matrices with the following form:







Working
with Arrays
 2
σ2
...
σ2µ
 σµ + σ2

2
2
2
σµ
σµ + σ . . .
σ2µ


..
..
..
..

.
.
.
.

σ2µ
σ2µ
. . . σ2µ + σ2
The log-likelihood for this model is
lnL = −0.5(NT ln(2π) − ln | Ω | + (Y − XB)0Ω−1 (Y − XB))
where Ω is the block-diagonal moment matrix of the residuals.
Computing the Log-likelihood
Using GAUSS arrays, we can compute the log-likelihood of this model without resorting to do
loops. Let Y be a 100×3×1 array of observations on the dependent variable, and X a 100×3×5
array of observations on the independent variables. Further let B be a 5×1 vector of coefficients,
and sigu and sige be the residual variances of µ and respectively. Then, in explicit steps we
compute
N = 100;
T = 3;
K = 5;
15-33
GAUSS User Guide
sigma = sigu * ones(T,T) + sige * eye(T); /* TxT sigma */
sigmai = invpd(sigma); /* sigma inverse */
lndet = N*ln(detl);
E = Y - amult(X,areshape(B,N|K|1)); /* residuals */
Omegai = areshape(sigmai,N|T|T); /* diagonal blocks */
/* stacked in a vector array */
R1 = amult(atranspose(E,1|3|2),Omegai); /* E’Omegai */
R2 = amult(R1,E); /* R1*E */
lnL = -0.5*(N*T*ln(2*pi) - lndet + asum(R2,3)); /* log-likelhood */
All of this can be made more efficient by nesting statements, which eliminates copying of
temporary intervening arrays to local arrays. It is also useful to add a check for the positive
definiteness of sigma:
N = 100;
T = 3;
K = 5;
const = -0.5*N*T*ln(2*pi);
oldt = trapchk(1);
trap 1,1;
sigmai = invpd(sigu*ones(T,T)+sige*eye(T));
trap oldt,1;
if not scalmiss(sigmai);
E = Y - amult(X,areshape(B,N|K|1));
lnl = const + 0.5*N*ln(detl)0.5*asum(amult(amult(atranspose(E,1|3|2),
areshape(sigmai,N|T|T)),E),3);
else;
lnl = error(0);
endif;
15-34
Working with Arrays
15.7
Appendix
This is an incomplete list of special functions for working with arrays. Many GAUSS functions
have been modified to handle arrays and are not listed here. For example, cdfnc computes the
complement of the Normal cdf for each element of an array just as it would for a matrix. See the
documentation for these GAUSS functions for information about their behavior with arrays.
Concatenate conformable matrices and arrays in a user-specified
dimension.
aeye
Create an array of identity matrices.
amax
Compute the maximum elements across a dimension of an array.
amean
Compute the mean along one dimension of an array.
amin
Compute the minimum elements across a dimension of an array.
amult
Perform a matrix multiplication on the last two trailing dimensions
of an array.
areshape
Reshape a scalar, matrix, or array into an array of user-specified size.
arrayalloc
Create an N-dimensional array with unspecified contents.
arrayinit
Create an N-dimensional array with a specified fill value.
arraytomat
Change an array to type matrix.
asum
Compute the sum across one dimension of an array.
atranspose
Transpose an N-dimensional array.
getarray
Get a contiguous subarray from an N-dimensional array.
getdims
Get the number of dimensions in an array.
getmatrix
Get a contiguous matrix from an N-dimensional array.
getmatrix4D
Get a contiguous matrix from a 4-dimensional array.
getorders
Get the vector of orders corresponding to an array.
15-35
Working
with Arrays
aconcat
GAUSS User Guide
15-36
getscalar3D
Get a scalar from a 3-dimensional array.
getscalar4D
Get a scalar form a 4-dimensional array.
loopnextindex
Increment an index vector to the next logical index and jump to the
specified label if the index did not wrap to the beginning.
mattoarray
Change a matrix to a type array.
nextindex
Return the index of the next element or subarray in an array.
previousindex
Return the index of the previous element or subarray in an array.
putarray
Put a contiguous subarray into an N-dimensional array and return
the resulting array.
setarray
Set a contiguous subarray of an N-dimensional array.
walkindex
Walk the index of an array forward or backward through a specified
dimension.
Structures
16.1.1
Structures
16.1
16
Basic Structures
Structure Definition
The syntax for a structure definition is
struct A { /* list of members */ };
The list of members can include scalars, arrays, matrices, strings, and string arrays, as well as
other structures. As a type, scalars are unique to structures and don’t otherwise exist.
For example, the following defines a structure containing the possible contents:
struct generic_example {
scalar x;
matrix y;
16-1
GAUSS User Guide
string s1;
string array s2
struct other_example t;
};
A useful convention is to put the structure definition into a file with a .sdf extension. Then, for
any command file or source code file that requires this definition, put
#include filename.sdf
For example:
#include example.sdf
These statements create structure definitions that persist until the workspace is cleared. They do
not create structures, only structure-type definitions. The next section describes how to create an
instance of a structure.
16.1.2
Declaring an Instance
To use a structure, it is necessary to declare an instance. The syntax for this is
struct structure type structure name;
For example:
#include example.sdf
struct generic_example p0;
16-2
Structures
16.1.3
Initializing an Instance
Members of structures are referenced using a “dot” syntax:
p0.x = rndn(20,3);
The same syntax applies when referred to on the right-hand side:
mn = meanc(p0.x);
Initialization of Global Structures
scalar
matrix
array
string
string array
Structures
Global structures are initialized at compile time. Each member of the structure is initialized
according to the following schedule:
0, a scalar zero
, an empty matrix with zero rows and zero columns
0, a 1-dimensional array set to zero
””, a null string
””, a 1×1 string array set to null
If a global already exists in memory, it will not be reinitialized. It may be the case in your program
that when it is rerun, the global variables may need to be reset to default values. That is, your
program may depend on certain members of a structure being set to default values that are set to
some other value later in the program. When you rerun this program, you will want to reinitialize
the global structure. To do this, make an assignment to at least one of the members. This can be
made convenient by writing a procedure that declares a structure and initializes one of its members
to a default value, and then returns it. For example:
/* ds.src */
#include ds.sdf
proc dsCreate;
16-3
GAUSS User Guide
struct DS d0;
d0.dataMatrix = 0;
retp(d0);
endp;
Calling this function after declaring an instance of the structure will ensure initialization to default
values each time your program is run:
struct DS d0;
d0 = dsCreate;
Initializing Local Structures
Local structures, which are structures defined inside procedures, are initialized at the first
assignment. The procedure may have been written in such a way that a subset of structures are
used an any one call, and in that case time is saved by not initializing the unused structures. They
will be initialized to default values only when the first assignment is made to one of its members.
16.1.4
Arrays of Structures
To create a matrix of instances, use the reshape command:
#include ds.sdf
struct DS p0;
p0 = reshape(dsCreate,5,1);
This creates a 5×1 vector of instances of DS structures, with all of the members initialized to
default values.
When the instance members have been set to some other values, reshape will produce multiple
copies of that instance set to those values.
Matrices or vectors of instances can also be created by concatenation:
16-4
Structures
#include trade.sdf
struct option p0,p1,p2;
p0 = optionCreate;
p1 = optionCreate;
p2 = p1 | p0;
16.1.5
Structure Indexing
Structure indexing may be used to reference a particular element in a structure array. The syntax
follows that of matrix indexing. For example, given the following structure definition:
Structures
struct example1 {
matrix x;
matrix y;
string str;
};
you could create an array of example1 structures and index it as follows:
struct example1 e1a;
struct example1 e1b;
e1a = e1a | e1b;
e1a[2,1].y = rndn(25,10);
In this example, e1a and e1b are concatenated to create a 2×1 array of example1 structures that is
assigned back to e1a. Then the y member of the [2,1] element of e1a is set to a random matrix.
Indexing of structure arrays can occur on multiple levels. For example, let’s define the following
structures:
struct example3 {
16-5
GAUSS User Guide
matrix w;
string array sa;
};
struct example2 {
matrix z;
struct example3 e3;
};
and let’s redefine example1 to include an instance of an example2 structure:
struct example1 {
matrix x;
matrix y;
string str;
struct example2 e2;
};
“ttfamily “bfseries “upshape LaTeX Error: File ‘structtree’ not found.ΩΩSee the LaTeX manual or LaTeX Com
Figure 16.1: Structure tree for e1
Let’s assume that we have an example1 structure e1 like the one displayed in Figure 16.1. We
could then index the structure as follows:
r = e1.e2[3,1].e3[2,1].w
You can also use indexing to reference the structure itself, rather than a member of that structure:
struct example3 e3tmp;
e3tmp = e1.e2[3,1].e3[2,1];
16-6
Structures
Or you can use indexing to reference a subarray of structures:
e3tmp = e1.e2[3,1].e3[.,1];
In this case, e3tmp would be an array of 3×1 example3 structures, since the [3,1] member of
e1.e2 contains a 3×1 array of example3 structures.
It is important to remember, however, that when indexing a structure array on multiple levels, only
the final index may resolve to an array of structures. For example:
e3tmp = e1.e2[.,1].e3[2,1];
would be invalid, since e1.e2[.,1] resolves to a 3×1 array of example2 structures.
16.1.6
Saving an Instance to the Disk
ret = savestruct(instance,filename);
The file on the disk will have an .fsr extension.
For example:
#include ds.sdf
struct DS p0;
p0 = reshape(dsCreate,2,1);
retc = saveStruct(p2,"p2");
This saves the vector of instances in a file called p2.fsr. retc will be zero if the save was
successful; otherwise, nonzero.
16-7
Structures
Instances and vectors or matrices of instances of structures can be saved in a file on the disk, and
later loaded from the file onto the disk. The syntax for saving an instance to the disk is
GAUSS User Guide
16.1.7
Loading an Instance from the Disk
The syntax for loading a file containing an instance or matrix of instances is
instance, retc
= loadstruct(file name,structure name);
For example:
#include trade.sdf;
struct DS p3;
{ p3, retc } = loadstruct("p2","ds");
16.1.8
Passing Structures to Procedures
Structures or members of structures can be passed to procedures. When a structure is passed as an
argument to a procedure, it is passed by value. The structure becomes a local copy of the structure
that was passed. The data in the structure is not duplicated unless the local copy of the structure
has a new value assigned to one of its members. Structure arguments must be declared in the
procedure definition:
struct rectangle {
matrix ulx;
matrix uly;
matrix lrx;
matrix lry;
};
proc area(struct rectangle rect);
retp((rect.lrx - rect.ulx).*(rect.uly - rect.lry));
endp;
Local structures are defined using a struct statement inside the procedure definition:
16-8
Structures
proc center(struct rectangle rect);
struct rectangle cent;
cent.lrx = (rect.lrx - rect.ulx) / 2;
cent.ulx = -cent.lrx;
cent.uly = (rect.uly - rect.lry) / 2;
cent.lry = -cent.uly;
retp(cent);
endp;
16.2
Structure Pointers
A structure pointer is a separate data type that contains the address of a structure and is used to
reference that structure.
Structures
16.2.1
Creating and Assigning Structure Pointers
Given the following structure type definition:
struct example_struct {
matrix x;
matrix y;
};
a pointer to an example_struct structure can be created with the following syntax:
struct example_struct *esp;
However, at this point, esp is not yet pointing at anything. It has only been defined to be the kind
of pointer that points at example_struct structures. To set it to point at a particular structure
instance, we must first create the structure instance:
16-9
GAUSS User Guide
struct example_struct es;
and then we can set esp to point at es by setting esp to the address of es:
esp = &es;
The following code:
struct example_struct es2;
es2 = *esp;
copies the contents of the structure that esp is pointing at (i.e., the contents of es) to es2. It is the
same as
struct example_struct es2;
es2 = es;
16.2.2
Structure Pointer References
To reference a member of a structure, we use a “dot” syntax. For example, we might use the
following code to set the x member of es.
es.x = rndn(3,3);
To reference a member of a structure using a pointer to that structure, we use an “arrow” syntax.
For example, we might use the following code to set the x member of es using the pointer esp:
esp->x = rndn(10,5);
16-10
Structures
This code will modify es, since esp is merely a pointer to es.
Structure pointers cannot be members of a structure. The following is illegal:
struct example_struct_2 {
matrix z;
struct example_struct *ep;
};
Therefore, since a structure pointer will never be a member of a structure, neither
sp1->sp2->x;
nor
will ever be valid (sp1 and sp2 are assumed to be structure pointers, s a structure instance, and x a
matrix). The “arrow” (->) will only be valid if it is used for the first (or furthest left) dereference,
as in:
sp1->st.x;
At this point we do not support indexing of structure pointers. Thus, a structure pointer should
point at a scalar structure instance, not a matrix of structures. However, you may index members
of that scalar structure instance. So, for example, let us suppose that youdefined the following
structure types:
struct sb {
matrix y;
matrix z;
16-11
Structures
s.sp1->x;
GAUSS User Guide
};
struct sa {
matrix x;
struct structb s;
};
and then created an instance of an sa structure, a0, setting a0.s to a 3×2 matrix of sb structures.
The following would be legal:
struct sa *sap
sap = &a0;
sap->s[3,1].y = rndn(3,3);
16.2.3
Using Structure Pointers in Procedures
Structure pointers are especially useful in cases where structures are passed into and out of
procedures. If a procedure takes a structure as an argument and modifies any members of that
structure, then it makes a local copy of the entire structure before modifying it. Thus if you want
to have the modified copy of the structure after running the procedure, you need to pass the
structure out of the procedure as one of its return arguments. For example:
struct example_struct {
matrix x;
matrix y;
matrix z;
};
proc product(struct example_struct es);
es.z = (es.x).*(es.y);
retp(es);
endp;
struct example_struct es1;
16-12
Structures
es1.x = rndn(1000,100);
es1.y = rndn(1000,1);
es1 = product(es1);
In this example, the structure es1 is passed into the procedure, copied and modified. The modified
structure is then passed out of the procedure and assigned back to es1.
Structure pointers allow you to avoid such excessive data copying and eliminate the need to pass a
structure back out of a procedure in cases like this. When you pass a structure pointer into a
procedure and then modify a member of the structure that it references, the actual structure is
modified rather than a local copy of it. Thus there is no need to pass the modifed structure back
out of the procedure. For example, the above example could be accomplished using structure
pointers as follows:
Structures
struct example_struct {
matrix x;
matrix y;
matrix z;
};
proc(0) = product(struct example_struct *esp);
esp->z = (esp->x).*(esp->y);
endp;
struct example_struct es1;
struct example_struct *es1p;
es1p = &es1;
es1.x = rndn(1000,100);
es1.y = rndn(1000,1);
product(es1p);
In this case, the procedure modifies the structure es1, which es1p is pointing at, instead of a local
copy of the structure.
16-13
GAUSS User Guide
16.3
Special Structures
There are three common types of structures that will be found in the GAUSS Run-Time Library
and applications.
The DS and PV structures are defined in the GAUSS Run-Time Library. Their definitions are
found in ds.sdf and pv.sdf, respectively, in the src source code subdirectory.
Before structures, many procedures in the Run-Time Library and all applications had global
variables serving a variety of purposes, such as setting and altering defaults. Currently, these
variables are being entered as members of “control” structures.
16.3.1
The DS Structure
The DS structure, or “data” structure, is a very simple structure. It contains a member for each
GAUSS data type. The following is found in ds.sdf:
struct DS {
scalar type;
matrix dataMatrix;
array dataArray;
string dname;
string array vnames;
};
This structure was designed for use by the various optimization functions in GAUSS, in particular,
sqpSolvemt, as well as a set of gradient procedures, gradmt, hessmt, et al.
These procedures all require that the user provide a procedure computing a function (to be
optimized or take the derivative of, etc.), which takes the DS structure as an argument. The
Run-Time Library procedures such as sqpSolvemt take the DS structure as an argument and
pass it on to the user-provided procedure without modification. Thus, the user can put into that
structure whatever might be needed as data in the procedure.
To initialize an instance of a DS structure, the procedure dsCreate is defined in ds.src:
16-14
Structures
#include ds.sdf
struct DS d0;
d0 = dsCreate;
16.3.2
The PV Structure
The PV structure, or parameter vector structure, is used by various optimization, modelling, and
gradient procedures, in particular sqpSolvemt, for handling the parameter vector. The GAUSS
Run-Time Library contains special functions that work with this structure. They are prefixed by
“pv” and defined in pv.src. These functions store matrices and arrays with parameters in the
structure, and retrieve various kinds of information about the parameters and parameter vector
from it.
“Packing” into a PV Structure
The typical situation involves two parts: first, “packing” the parameters into the PV structure,
which is then passed to the Run-Time Library procedure or application; and second,
“unpacking” the PV structure in the user-provided procedure for use in computing the objective
function. For example, to pack parameters into a PV structure:
#include sqpsolvemt.sdf
/* starting values */
b0 = 1; /* constant in mean equation */
garch = { .1, .1 }; /* garch parameters */
arch = { .1, .1 }; /* arch parameters */
omega = .1 /* constant in variance equation */
16-15
Structures
The various procedures in the Run-Time Library and applications for optimization, modelling,
derivatives, etc., all require a parameter vector. Parameters in complex models, however, often
come in matrices of various types, and it has been the responsibility of the programmer to generate
the parameter vector from the matrices and vice versa. The PV procedures make this problem
much more convenient to solve.
GAUSS User Guide
struct PV p0;
p0
p0
p0
p0
=
=
=
=
pvPack(pvCreate,b0,"b0");
pvPack(p0,garch,"garch");
pvPack(p0,arch,"arch");
pvPack(p0,omega,"omega");
/* data */
z = loadd("tseries");
struct DS d0;
d0.dataMatrix = z;
Next, in the user-provided procedure for computing the objective function, in this case minus the
log-likelihood, the parameter vector is unpacked:
proc ll(struct PV p0, struct DS d0);
local b0,garch,arch,omega,p,q,h,u,vc,w;
b0 = pvUnpack(p0,"b0");
garch = pvUnpack(p0,"garch");
arch = pvUnpack(p0,"arch");
omega = pvUnpack(p0,"omega");
p = rows(garch);
q = rows(arch);
u = d0.dataMatrix - b0;
vc = moment(u,0)/rows(u);
w = omega + (zeros(q,q) | shiftr((u.*ones(1,q))’,
seqa(q-1,-1,q))) * arch;
h = recserar(w,vc*ones(p,1),garch);
logl = -0.5 * ((u.*u)./h + ln(2*pi) + ln(h));
retp(logl);
16-16
Structures
endp;
Masked Matrices
The pvUnpack function unpacks parameters into matrices or arrays for use in computations. The
first argument is a PV structure containing the parameter vector. Sometimes the matrix or vector is
partly parameters to be estimated (that is, a parameter to be entered in the parameter vector) and
partly fixed parameters. To distinguish between estimated and fixed parameters, an additional
argument is used in the packing function called a “mask”, which is strictly conformable to the
input matrix. Its elements are set to 1 for an estimated parameter and 0 for a fixed parameter. For
example:
p0 = pvPackm(p0,.1*eye(3),"theta",eye(3));
When this matrix is unpacked, the entire matrix is returned with current values of the parameters
on the diagonal:
print pvUnpack(p0,"theta");
0.1000 0.0000 0.0000
0.0000 0.1000 0.0000
0.0000 0.0000 0.1000
Symmetric Matrices
Symmetric matrices are a special case because even if the entire matrix is to be estimated, only the
nonredundant portion is to be put into the parameter vector. Thus, for them there are special
procedures. For example:
16-17
Structures
Here just the diagonal of a 3×3 matrix is added to the parameter vector.
GAUSS User Guide
vc = { 1 .6 .4, .6 1 .2, .4 .2 1 };
p0 = pvPacks(p0,vc,"vc");
There is also a procedure for masking in case only a subset of the nonredundant elements are to be
included in the parameter vector:
vc = { 1 .6 .4, .6 1 .2, .4 .2 1 };
mask = { 1 1 0, 1 1 0, 0 0 1 };
p0 = pvPacksm(p0,vc,"vc",mask);
Fast Unpacking
When unpacking matrices using a matrix name, pvUnpack has to make a search through a list of
names, which is relatively time-consuming. This can be alleviated by using an index rather than a
name in unpacking. To do this, though, requires using a special pack procedure that establishes the
index:
p0 = pvPacki(p0,b0,"b0",1);
p0 = pvPacki(p0,garch,"garch",2);
p0 = pvPacki(p0,arch,"arch",3);
p0 = pvPacki(p0,omega,"omega",4);
Now they may be unpacked using the index number:
b0 = pvUnpack(p0,1);
garch = pvUnpack(p0,2);
arch = pvUnpack(p0,3);
omega = pvUnpack(p0,4);
When packed with an index number, they may be unpacked either by index or by name, but
unpacking by index is faster.
16-18
Structures
16.3.3
Miscellaneous PV Procedures
pvList
This procedure generates a list of the matrices or arrays packed into the structure:
p0 = pvPack(p0,b0,"b0");
p0 = pvPack(p0,garch,"garch");
p0 = pvPack(p0,arch,"arch");
p0 = pvPack(p0,omega,"omega");
print pvList(p0);
b0
garch
arch
omega
Structures
pvLength
This procedure returns the length of the parameter vector:
print pvLength(p0);
6.0000
pvGetParNames
This procedure generates a list of parameter names:
print pvGetParNames(p0);
16-19
GAUSS User Guide
b0[1,1]
garch[1,1]
garch[2,1]
arch[1,1]
arch[2,1]
omega[1,1]
pvGetParVector
This procedure returns the parameter vector itself:
print pvGetParVector(p0);
1.0000
0.1000
0.1000
0.1000
0.1000
1.0000
pvPutParVector
This procedure replaces the parameter vector with the one in the argument:
newp = { 1.5, .2, .2, .3, .3, .8 };
p0 = pvPutParVector(newp);
print pvGetParVector(p0);
1.5000
0.2000
0.2000
0.3000
0.3000
0.8000
16-20
Structures
pvGetIndex
This procedure returns the indices in the parameter vector of the parameters in a matrix. These
indices are useful when setting linear constraints or bounds in sqpSolvemt. Bounds, for example,
are set by specifying a K×2 matrix where K is the length of the parameter vector and the first
column are the lower bounds and the second the upper bounds. To set the bounds for a particular
parameter, then, requires knowing where that parameter is in the parameter vector. This
information can be found using pvGetIndex. For example:
// get indices of lambda parameters in parameter vector
lind = pvGetIndex(par0,"lambda");
// set bounds constraint matrix to unconstrained default
c0.bounds = ones(pvLength(par0),1).*(-1e250˜1e250);
// set bounds for lambda parameters to be positive
c0.bounds[lind,1] = zeros(rows(lind),1);
Structures
16.3.4
Control Structures
Another important class of structures is the “control” structure. Applications developed before
structures were introduced into GAUSS typically handled some program specifications by the use
of global variables which had some disadvantages, in particular, preventing the nesting of calls to
procedures.
Currently, the purposes served by global variables are now served by the use of a control structure.
For example, for sqpSolvemt:
struct sqpSolvemtControl {
matrix A;
matrix B;
matrix C;
matrix D;
scalar eqProc;
scalar ineqProc;
16-21
GAUSS User Guide
matrix
scalar
scalar
scalar
scalar
scalar
scalar
scalar
scalar
scalar
scalar
scalar
scalar
matrix
};
bounds;
gradProc;
hessProc;
maxIters;
dirTol;
CovType;
feasibleTest;
maxTries;
randRadius;
trustRadius;
seed;
output;
printIters;
weights;
The members of this structure determine optional behaviors of sqpSolvemt.
16.4
sqpSolvemt
sqpSolvemt is a procedure in the GAUSS Run-Time Library that solves the general nonlinear
programming problem using a Sequential Quadratic Programming descent method, that is, it
solves
min f (θ)
subject to
Aθ = B
Cθ>=D
H(θ) = 0
G(θ)>=0
θlb <=θ<=θub
16-22
linear equality
linear inequality
nonlinear equality
nonlinear inequality
bounds
Structures
The linear and bounds constraints are redundant with respect to the nonlinear constraints, but are
treated separately for computational convenience.
The call to sqpSolvemt has four input arguments and one output argument:
out = SQPsolveMT(&fct,P,D,C);
16.4.1
Input Arguments
The first input argument is a pointer to the objective function to be minimized. The procedure
computing this objective function has two arguments: a PV structure containing the start values,
and a DS structure containing data, if any. For example:
Structures
proc fct(struct PV p0, struct DS d0);
local y, x, b0, b, e, s;
y = d0[1].dataMatrix;
x = d0[2].dataMatrix;
b0 = pvUnpack(p0,"constant");
b = pvUnpack(p0,"coefficients");
e = y - b0 - x * b;
s = sqrt(e’e/rows(e));
retp(-pdfn(e/s);
endp;
Note that this procedure returns a vector rather than a scalar. When the objective function is a
properly defined log-likelihood, returning a vector of minus log-probabilities permits the
calculation of a QML covariance matrix of the parameters.
The remaining input arguments are structures:
P
a PV structure containing starting values of the parameters
D
a DS structure containing data, if any
16-23
GAUSS User Guide
an sqpSolvemtControl structure
C
The DS structure is optional. sqpSolvemt passes this argument on to the user-provided procedure
that &fct is pointing to without modification. If there is no data, a default structure can be passed
to it.
sqpSolvemtControl Structure
A default sqpSolvemtControl structure can be passed in the fourth argument for an
unconstrained problem. The members of this structure are as follows:
A
M×K matrix, linear equality constraint coecients: Aθ = B, where p is a
vector of the parameters.
B
M×1 vector, linear equality constraint constants: Aθ = B, where p is a
vector of the parameters.
C
M×K matrix, linear inequality constraint coefficients: Cθ = D, where p is a
vector of the parameters.
D
M×1 vector, linear inequality constraint constants: Cθ = D, where p is a
vector of the parameters.
eqProc
scalar, pointer to a procedure that computes the nonlinear equality
constraints. When such a procedure has been provided, it has two input
arguments, instances of PV and DS structures, and one output argument, a
vector of computed inequality constraints.
Default = .; i.e., no inequality procedure.
IneqProc
scalar, pointer to a procedure that computes the nonlinear inequality
constraints. When such a procedure has been provided, it has two input
arguments, instances of PV and DS structures, and one output argument, a
vector of computed inequality constraints.
Default = .; i.e., no inequality procedure.
16-24
Structures
Bounds
1×2 or K×2 matrix, bounds on parameters. If 1×2 all parameters have same
bounds.
Default = -1e256 1e256 .
GradProc
scalar, pointer to a procedure that computes the gradient of the function
with respect to the parameters. When such a procedure has been provided,
it has two input arguments, instances of PV and DS structures, and one
output argument, the derivatives. If the function procedure returns a scalar,
the gradient procedure returns a 1×K row vector of derivatives. If function
procedure turns an N×1 vector, the gradient procedure returns an N×K
matrix of derivatives.
This procedure may compute a subset of the derivatives. sqpSolvemt will
compute numerical derivatives for all those elements set to missing values
in the return vector or matrix.
Default = .; i.e., no gradient procedure has been provided.
HessProc
Default = .; i.e., no Hessian procedure has been provided.
Whether the objective function procedure returns a scalar or vector, the
Hessian procedure must return a K×K matrix. Elements set to missing
values will be computed numerically by sqpSolvemt.
MaxIters
scalar, maximum number of iterations. Default = 1e+5.
MaxTries
scalar, maximum number of attemps in random search. Default = 100.
DirTol
scalar, convergence tolerance for gradient of estimated coefficients. Default
= 1e-5. When this criterion has been satisifed, sqpSolvemt exits the
iterations.
CovType
scalar, if 2, QML covariance matrix, else if 0, no covariance matrix is
computed, else ML covariance matrix is computed. For a QML covariance
matrix, the objective function procedure must return an N×1 vector of
minus log-probabilities.
16-25
Structures
scalar, pointer to a procedure that computes the Hessian; i.e., the matrix of
second order partial derivatives of the function with respect to the
parameters. When such a procedure has been provided, it has two input
arguments, instances of PV and DS structures, and one output argument, a
vector of computed inequality constraints.
GAUSS User Guide
FeasibleTest
scalar, if nonzero, parameters are tested for feasibility before computing
function in line search. If function is defined outside inequality boundaries,
then this test can be turned off. Default = 1.
randRadius
scalar, if zero, no random search is attempted. If nonzero, it is the radius of
the random search. Default = .001.
seed
scalar, if nonzero, seeds random number generator for random search,
otherwise time in seconds from midnight is used.
trustRadius
scalar, radius of the trust region. If scalar missing, trust region not applied.
The trust sets a maximum amount of the direction at each iteration. Default
= .001.
output
scalar, if nonzero, results are printed. Default = 0.
PrintIters
scalar, if nonzero, prints iteration information. Default = 0.
weights
vector, weights for objective function returning a vector. Default = 1.
16.4.2
Output Argument
The single output argument is an sqpSolvemtOut structure. Its definition is:
struct SQPsolveMTOut {
struct PV par;
scalar fct;
struct SQPsolveMTLagrange lagr;
scalar retcode;
matrix moment;
matrix hessian;
matrix xproduct;
};
The members of this structure are:
16-26
Structures
par
instance of a PV structure containing the parameter estimates are placed in
the matrix member par.
fct
scalar, function evaluated at final parameter estimates.
lagr
an instance of an SQPLagrange structure containing the Lagrangeans for
the constraints. For an instance named lagr, the members are:
lagr.lineq
M×1 vector, Lagrangeans of linear equality
constraints
lagr.nlineq
N×1 vector, Lagrangeans of nonlinear equality
constraints
lagr.linineq
P×1 vector, Lagrangeans of linear inequality
constraints
lagr.nlinineq Q×1 vector, Lagrangeans of nonlinear inequality
constraints
lagr.bounds
K×2 matrix, Lagrangeans of bounds
retcode
return code:
0
normal convergence
1
forced exit
2
maximum number of iterations exceeded
3
function calculation failed
4
gradient calculation failed
5
Hessian calculation failed
6
line search failed
7
error with constraints
8
function complex
9
feasible direction couldn’t be found
16-27
Structures
Whenever a constraint is active, its associated Lagrangean will be nonzero.
For any constraint that is inactive throughout the iterations as well as at
convergence, the corresponding Lagrangean matrix will be set to a scalar
missing value.
GAUSS User Guide
16.4.3
Example
Define
Y = Λη + θ
where Λ is a K×L matrix of loadings, η an L×1 vector of unobserved “latent” variables, and θ a
K×1 vector of unobserved errors. Then
Σ = ΛΦΛ0Ψ
where Φ is the L×L covariance matrix of the latent variables, and Ψ is the K×K covariance matrix
of the errors.
The log-likelihood of the ith observation is
logP(i) = − 12 [Kln(2π) + ln | π | +Y(i)ΣY(i)0]
Not all elements of Λ, Φ, and Ψ can be estimated. At least one element of each column of Λ must
be fixed to 1, and Ψ is usually a diagonal matrix.
Constraints
To ensure a well-defined log-likelihood, constraints on the parameters are required to guarantee
positive definite covariance matrices. To do this, a procedure is written that returns the eigenvalues
of Σ and Φ minus a small number. sqpSolvemt then finds parameters such that these eigenvalues
are greater than or equal to that small number.
16-28
Structures
16.4.4
The Command File
This command file can be found in the file sqpfact.e in the examples subdirectory:
#include sqpsolvemt.sdf
lambda = { 1.0
0.5
0.0
0.0
lmask = { 0
1
0
0
0.0,
0.0,
1.0,
0.5 };
0,
0,
0,
1 };
psi = { 0.6
0.0
0.0
0.0
0.0
0.6
0.0
0.0
0.0
0.0
0.6
0.0
tmask = { 1
0
0
0
0
1
0
0
0,
0,
0,
1 };
struct
par0 =
par0 =
par0 =
par0 =
0
0
1
0
Structures
phi = { 1.0 0.3,
0.3 1.0 };
0.0,
0.0,
0.0,
0.6 };
PV par0;
pvCreate;
pvPackm(par0,lambda,"lambda",lmask);
pvPacks(par0,phi,"phi");
pvPacksm(par0,psi,"psi",tmask);
struct SQPsolveMTControl c0;
16-29
GAUSS User Guide
c0 = sqpSolveMTcontrolCreate;
lind = pvGetIndex(par0,"lambda"); /*
/*
/*
tind = pvGetIndex(par0,"psi");
/*
/*
/*
get indices of lambda */
parameters in parameter */
vector */
get indices of psi */
parameters in parameter */
vector */
c0.bounds = ones(pvLength(par0),1).*(-1e250˜1e250);
c0.bounds[lind,1] = zeros(rows(lind),1);
c0.bounds[lind,2] = 10*ones(rows(lind),1);
c0.bounds[tind,1] = .001*ones(rows(tind),1);
c0.bounds[tind,2] = 100*ones(rows(tind),1);
c0.output = 1;
c0.printIters = 1;
c0.trustRadius = 1;
c0.ineqProc = &ineq;
c0.covType = 1;
struct DS d0;
d0 = dsCreate;
d0.dataMatrix = loadd("maxfact");
output file = sqpfact.out reset;
struct SQPsolveMTOut out0;
out0 = SQPsolveMT(&lpr,par0,d0,c0);
lambdahat = pvUnpack(out0.par,"lambda");
phihat = pvUnpack(out0.par,"phi");
psihat = pvUnpack(out0.par,"psi");
print "estimates";
print;
print "lambda" lambdahat;
16-30
Structures
print;
print "phi" phihat;
print;
print "psi" psihat;
struct PV stderr;
stderr = out0.par;
Structures
if not scalmiss(out0.moment);
stderr = pvPutParVector(stderr,sqrt(diag(out0.moment)));
lambdase = pvUnpack(stderr,"lambda");
phise = pvUnpack(stderr,"phi");
psise = pvUnpack(stderr,"psi");
print "standard errors";
print;
print "lambda" lambdase;
print;
print "phi" phise;
print;
print "psi" psise;
endif;
output off;
proc lpr(struct PV par1, struct DS data1);
local lambda,phi,psi,sigma,logl;
lambda = pvUnpack(par1,"lambda");
phi = pvUnpack(par1,"phi");
psi = pvUnpack(par1,"psi");
sigma = lambda*phi*lambda’ + psi;
logl = -lnpdfmvn(data1.dataMatrix,sigma);
retp(logl);
endp;
proc ineq(struct PV par1, struct DS data1);
16-31
GAUSS User Guide
local lambda,phi,psi,sigma,e;
lambda = pvUnpack(par1,"lambda");
phi = pvUnpack(par1,"phi");
psi = pvUnpack(par1,"psi");
sigma = lambda*phi*lambda’ + psi;
e = eigh(sigma) - .001; /* eigenvalues of sigma */
e = e | eigh(phi) - .001; /* eigenvalues of phi */
retp(e);
endp;
16-32
Run-Time Library Structures
17
Two structures are used by several GAUSS Run-Time Library functions for handling parameter
vectors and data: the PV parameter structure and the DS data structure.
17.1
The PV Parameter Structure
Suppose you are optimizing a function containing a K×L matrix of coefficients. The optimization
function requires a parameter vector but your function uses a K×L matrix. Your needs and the
needs of the optimization function can be both satisfied by an instance of the structure of type PV.
For example:
struct PV p1;
p1 = pvCreate;
17-1
RTL
Structures
The members of an instance of structure of type PV are all “private,” that is, not accessible directly
to the user. It is designed to handle parameter vectors for threadsafe optimization functions.
Entering and receiving parameter vectors, and accessing properties of this vector, are
accomplished using special functions.
GAUSS User Guide
x = zeros(4,3); /* on input contains start values, */
/* on exit contains estimates
*/
p1 = pvPack(p1,x,"coefficients");
The pvCreate function initializes p1 to default values. pvPack enters the 4×3 matrix stored
row-wise as a 12×1 parameter vector for the optimization function. The optimization program will
pass the instance of the structure of type PV to your objective function.
By calling pvUnpack your 4×3 coefficient matrix is retrieved from the parameter vector. For
example, in your procedure you have
x = pvUnpack(p1,"coefficients");
and now x is a 4×3 matrix of coefficients for your use in calculating the object function.
Suppose that your objective function has parameters to be estimated in a covariance matrix. The
covariance matrix is a symmetric matrix where only the lower left portion contains unique values
for estimation. To handle this, use pvPacks. For example:
struct PV p1;
p1 = pvCreate;
cov = { 1 .1 .1,
.1 1 .1,
.1 .1 1 };
p1 = pvPacks(p1,cov,"covariance");
Only the lower left portion of cov will be stored in the parameter vector. When the covariance
matrix is unpacked, the parameters in the parameter vector will be entered into both the lower and
upper portions of the matrix.
There may be cases where only a portion of a matrix being used to compute the objective function
are parameters to be estimated. In this case use pvPackm with a “mask” matrix that contains ones
where parameters are to be estimated and zeros otherwise. For example,
17-2
Run-Time Library Structures
struct PV p1;
p1 = pvCreate;
cov = { 1
.5
.5,
1 };
mask = { 0 1,
1 0 };
p1 = pvPacksm(p1,cov,"correlation",mask);
Here only the one element in the lower left of cov is stored in the parameter vector. Suppose the
optimization program sends a trial value for that parameter of, say, .45. When the matrix is
unpacked in your procedure it will contain the fixed values associated with the zeros in the mask
as well as the trial value in that part of the matrix associated with the ones. Thus,
print unpack(p1,"correlation");
1.0000
.4500
.4500
1.0000
struct PV p1;
p1 = pvCreate;
m =
{ 0 .5 1,
.5 0 .3 };
mask = { 0
1
1
0
1,
0};
p1 = pvPackm(p1,m,"coefficients",mask);
17-3
RTL
Structures
A mask may also be used with general matrices to store a portion of a matrix in the parameter
vector.
GAUSS User Guide
A PV instance can, of course, hold parameters from all these types of matrices: symmetric, masked
symmetric, rectangular, and masked rectangular. For example:
lambda = { 1.0
0.5
0.0
0.0
lmask
= {
0
1
0
0
phi = { 1.0
0.3
struct
par0 =
par0 =
par0 =
par0 =
1
0
0
0
0,
0,
0,
1 };
0.3,
1.0 };
theta = { 0.6
0.0
0.0
0.0
tmask = {
0.0,
0.0,
1.0,
0.5 };
0.0
0.6
0.0
0.0
0.0
0.0
0.6
0.0
0.0,
0.0,
0.0,
0.6 };
0
1
0
0
0
0
1
0
0,
0,
0,
1 };
PV par0;
pvCreate;
pvPackm(par0,lambda,"lambda",lmask);
pvPacks(par0,phi,"phi");
pvPacksm(par0,theta,"theta",tmask);
It isn’t necessary to know where in the parameter vector the parameters are located in order to use
them in your procedure calculating the objective function. Thus:
lambda = pvUnpack(par1,"lambda");
17-4
Run-Time Library Structures
phi = pvUnpack(par1,"phi");
theta = pvUnpack(par1,"theta");
sigma = lambda*phi*lambda’ + theta;
Additional functions are available to retrieve information on the properties of the parameter vector.
pvGetParVector and pvPutParVector get and put parameter vector from and into the PV
instance, pvGetParNames retrieves names for the elements of the parameter vector, pvList
returns the list of matrix names in the PV instance, pvLength the length of the parameter vector.
struct PV p1;
p1 = pvCreate;
cov = { 1
.5
.5,
1 };
mask = { 0 1,
1 0 };
p1 = pvPacksm(p1,cov,"correlation",mask);
print pvGetParVector(p1);
.5000
RTL
Structures
p1 = pvPutParVector(p1,.8);
print pvGetParVector(p1);
.8000
print pvUnpack(p1,"correlation");
1.0000
.8000
.8000
1.0000
print pvGetParNames(p1);
correlation[2,1]
17-5
GAUSS User Guide
print pvLength(p1);
1.0000
Also, pvTest tests an instance to make sure it is properly constructed. pvCreate generates an
initialized instance, and pvGetIndex returns the indices of the parameters of an input matrix in
the parameter vector. This last function is most useful when constructing linear constraint indices
for the optimization programs.
17.2
Fast Pack Functions
Unpacking matrices using matrix names is slow because it requires a string search through a string
array of names. A set of special packing functions are provided that avoid the search altogether.
These functions use a “table” of indices that you specify to find the matrix in the PV instance. For
example:
struct PV p1;
p1 = pvCreate(2);
y = rndn(4,1);
x = rndn(4,4);
p1 = pvPacki(p1,y,"Y",1);
p1 = pvPacki(p1,x,"X",2);
print pvUnpack(p1,1);
.3422
.0407
.5611
.0953
print pvUnpack(p1,"Y");
17-6
Run-Time Library Structures
.3422
.0407
.5611
.0953
The call to pvPacki puts an entry in the table associating the matrix in its second argument with
the index 1. As indicated above the matrix can be unpacked either by index or by name.
Unpacking by index, however, is much faster than by name.
Note that the matrix can be unpacked using either the index or the matrix name.
There are index versions of all four of the packing functions, pvPacki, pvPackmi, pvPacksi, and
pvPacksmi.
17.3
The DS Data Structure
An instance of the DS data structure contains the following members:
d0.dataMatrix
d0.dataArray
d0.type
d0.dname
d0.vnames
RTL
Structures
struct DS d0;
M×K matrix, data
N-dimensional array, data
scalar
string
string array
The definition and use of the elements of d0 are determined by the particular application and are
mostly up to the user. A typical use might use a vector of structures. For example, suppose the
objective function requires a vector of observations on a dependent variable as well as on K
independent variables. Then:
17-7
GAUSS User Guide
struct DS d0;
d0 = dsCreate;
y = rndn(20,1);
x = rndn(20,5);
d0 = reshape(d0,2,1);
d0[1].dataMatrix = y;
d0[2].dataMatrix = X;
The d0 instance would be passed to the optimization program which then passes it to your
procedure computing the objective function. For example:
proc lpr(struct PV p1, struct DS d1);
local u;
u = d0[1].dataMatrix - d0[2].dataMatrix * pvUnpack(p1,"beta");
retp(u’u);
endp;
A particular application may require setting other members of the DS instance for particular
purposes, but in general you may use them for your own purposes. For example, d0.dname could
be set to a GAUSS dataset name from which you read the data in the objective function procedure,
or d0.vnames could be set to the variable names of the columns of the data stored in
d0.dataMatrix, or d0.type could be an indicator variable for the elements of a vector of DS
instances.
The following are complete examples of the use of the PV and DS structures. The first example fits
a set of data to the Micherlitz model. It illustrates packing and unpacking by index.
#include sqpsolvemt.sdf
struct DS Y;
Y = dsCreate;
Y.dataMatrix = 3.183|
17-8
Run-Time Library Structures
3.059|
2.871|
2.622|
2.541|
2.184|
2.110|
2.075|
2.018|
1.903|
1.770|
1.762|
1.550;
struct DS X;
X = dsCreate;
X.dataMatrix = seqa(1,1,13);
struct DS Z;
Z = reshape(Z,2,1);
Z[1] = Y;
Z[2] = X;
c1.bounds = 0˜100;
RTL
Structures
struct SQPsolveMTControl c1;
c1 = sqpSolveMTcontrolCreate; /* initializes
*/
/* default values */
/* constrains parameters */
/* to be positive
*/
c1.CovType = 1;
c1.output = 1;
c1.printIters = 0;
c1.gradProc = &grad;
struct PV par1;
par1 = pvCreate(1);
17-9
GAUSS User Guide
start = { 2, 4, 2 };
par1 = pvPacki(par1,start,"Parameters",1);
struct SQPsolveMTout out1;
out1 = SQPsolveMT(&Micherlitz,par1,Z,c1);
estimates = pvGetParVector(out1.par);
print " parameter estimates ";
print estimates;
print;
print " standard errors ";
print sqrt(diag(out1.moment));
proc Micherlitz(struct PV par1,struct DS Z);
local p0,e,s2;
p0 = pvUnpack(par1,1);
e = Z[1].dataMatrix - p0[1] - p0[2]*exp(-p0[3]
*Z[2].dataMatrix);
s2 = moment(e,0)/(rows(e)-1);
retp( (2/rows(e))*(e.*e/s2 + ln(2*pi*s2)));
endp;
proc grad(struct PV par1, struct DS Z);
local p0,e,e1,e2,e3,w,g,s2;
p0 = pvUnpack(par1,1);
w = exp(-p0[3]*Z[2].dataMatrix);
e = z[1].dataMatrix - p0[1] - p0[2] * w;
s2 = moment(e,0) / rows(e);
e1 = - ones(rows(e),1);
e2 = -w;
e3 = p0[2]*Z[2].dataMatrix.*w;
w = (1 - e.*e / s2) / rows(e);
g = e.*e1 + w*(e’e1);
g = g ˜ (e.*e2 + w*(e’e2));
g = g ˜ (e.*e3 + w*(e’e3));
17-10
Run-Time Library Structures
retp(4*g/(rows(e)*s2));
endp;
This example estimates parameters of a “confirmatory factor analysis” model.
\#include sqpsolvemt.sdf
lambda = { 1.0
0.5
0.0
0.0
lmask
= {
0
1
0
0
phi = { 1.0
0.3
0.0
0.6
0.0
0.0
0.0
0.0
0.6
0.0
0.0,
0.0,
0.0,
0.6 };
0
1
0
0
0
0
1
0
0,
0,
0,
1 };
RTL
Structures
1
0
0
0
0,
0,
0,
1 };
0.3,
1.0 };
theta = { 0.6
0.0
0.0
0.0
tmask = {
0.0,
0.0,
1.0,
0.5 };
struct PV par0;
par0 = pvCreate;
par0 = pvPackm(par0,lambda,"lambda",lmask);
par0 = pvPacks(par0,phi,"phi");
par0 = pvPacksm(par0,theta,"theta",tmask);
17-11
GAUSS User Guide
struct SQPsolveMTControl c0;
c0 = sqpSolveMTcontrolCreate;
lind = pvGetIndex(par0,"lambda"); /* get indices of */
/* lambda parameters */
/* in parameter vector */
tind = pvGetIndex(par0,"theta"); /* get indices of */
/* theta parameters */
/* in parameter vector */
c0.bounds = ones(pvLength(par0),1).*(-1e250˜1e250);
c0.bounds[lind,1] = zeros(rows(lind),1);
c0.bounds[lind,2] = 10*ones(rows(lind),1);
c0.bounds[tind,1] = .001*ones(rows(tind),1);
c0.bounds[tind,2] = 100*ones(rows(tind),1);
c0.ineqProc = &ineq;
c0.covType = 1;
struct DS d0;
d0 = dsCreate;
d0.dataMatrix = loadd("maxfact");
struct SQPsolveMTOut out0;
out0 = SQPsolveMT(&lpr,par0,d0,c0);
lambdahat = pvUnpack(out0.par,"lambda");
phihat = pvUnpack(out0.par,"phi");
thetahat = pvUnpack(out0.par,"theta");
print "estimates";
print;
print "lambda" lambdahat;
print;
17-12
Run-Time Library Structures
print "phi" phihat;
print;
print "theta" thetahat;
struct PV stderr;
stderr = out0.par;
if not scalmiss(out0.moment);
stderr =
pvPutParVector(stderr,sqrt(diag(out0.moment)));
lambdase = pvUnpack(stderr,"lambda");
phise = pvUnpack(stderr,"phi");
thetase = pvUnpack(stderr,"theta");
print "standard errors";
print;
print "lambda" lambdase;
print;
print "phi" phise;
print;
print "theta" thetase;
endif;
RTL
Structures
proc lpr(struct PV par1, struct DS data1);
local lambda,phi,theta,sigma,logl;
lambda = pvUnpack(par1,"lambda");
phi = pvUnpack(par1,"phi");
theta = pvUnpack(par1,"theta");
sigma = lambda*phi*lambda’ + theta;
logl = -lnpdfmvn(data1.dataMatrix,sigma);
retp(logl);
endp;
17-13
GAUSS User Guide
proc ineq(struct PV par1, struct DS data1);
local lambda,phi,theta,sigma,e;
lambda = pvUnpack(par1,"lambda");
phi = pvUnpack(par1,"phi");
theta = pvUnpack(par1,"theta");
sigma = lambda*phi*lambda’ + theta;
e = eigh(sigma) - .001; /* eigenvalues of sigma */
e = e | eigh(phi) - .001; /* eigenvalues of phi */
retp(e);
endp;
17-14
Libraries
18
The GAUSS library system allows for the creation and maintenance of modular programs. The
user can create “libraries” of frequently used functions that the GAUSS system will automatically
find and compile whenever they are referenced in a program.
18.1
Autoloader
18-1
Libraries
The autoloader resolves references to procedures, keywords, matrices, and strings that are not
defined in the program from which they are referenced. The autoloader automatically locates and
compiles the files containing the symbol definitions that are not resolved during the compilation of
the main file. The search path used by the autoloader is first the current directory, and then the
paths listed in the src_path configuration variable in the order they appear. src_path can be
defined in the GAUSS configuration file.
GAUSS User Guide
18.1.1
Forward References
When the compiler encounters a symbol that has not previously been defined, that is called a
“forward reference”. GAUSS handles forward references in two ways, depending on whether they
are “left-hand side” or “right-hand side” references.
Left-Hand Side
A left-hand side reference is usually a reference to a symbol on the left-hand side of the equal sign
in an expression.
x = 5;
Left-hand side references, since they are assignments, are assumed to be matrices. In the statement
above, x is assumed to be a matrix and the code is compiled accordingly. If, at execution time, the
expression actually returns a string, the assignment is made and the type of the symbol x is forced
to string.
Some commands are implicit left-hand side assignments. There is an implicit left-hand side
reference to x in each statement below:
clear x;
load x;
open x = myfile;
Right-Hand Side
A right-hand side reference is usually a reference to a symbol on the right-hand side of the equal
sign in an expression such as:
18-2
Libraries
z = 6;
y = z + dog;
print y;
In the program above, since dog is not previously known to the compiler, the autoloader will
search for it in the active libraries. If it is found, the file containing it will be compiled. If it is not
found in a library, the autoload/autodelete state will determine how it is handled.
18.1.2
The Autoloader Search Path
If the autoloader is OFF, no forward references are allowed. Every procedure, matrix, and string
referenced by your program must be defined before it is referenced. An external statement can
be used above the first reference to a symbol, but the definition of the symbol must be in the main
file or in one of the files that are #include’d. No global symbols are deleted automatically.
If the autoloader is ON, GAUSS searches for unresolved symbol references during compilation
using a specific search path as outlined below. If the autoloader is OFF, an Undefined symbol
error message will result for right-hand side references to unknown symbols.
When autoload is ON, the autodelete state controls the handling of references to unknown
symbols.
The following search path will be followed to locate any symbols not previously defined:
Autodelete ON
1. user library
2. user-specified libraries.
Libraries
3. gauss library
4. current directory, then src_path for files with a .g extension.
Forward references are allowed and .g files need not be in a library. If there are symbols that
cannot be found in any of the places listed above, an Undefined symbol error message will be
18-3
GAUSS User Guide
generated and all uninitialized variables and all procedures with global references will be deleted
from the global symbol table. This autodeletion process is transparent to the user, since the
symbols are automatically located by the autoloader the next time the program is run. This process
results in more compile time, which may or may not be significant, depending on the speed of the
computer and the size of the program.
Autodelete OFF
1. user library
2. user-specified libraries.
3. gauss library
All .g files must be listed in a library. Forward references to symbols that are not listed in an
active library are not allowed. For example:
x = rndn(10,10);
y = sym(x);
/* Forward reference to sym */
proc sym(x);
retp(x+x’);
endp;
Use an external statement for anything referenced above its definition if autodelete is OFF:
external proc sym;
x = rndn(10,10);
y = sym(x);
proc sym(x);
retp(x+x’);
endp;
18-4
Libraries
When autodelete is OFF, symbols not found in an active library will not be added to the symbol
table. This prevents the creation of uninitialized procedures in the global symbol table. No
deletion of symbols from the global symbol table will take place.
Libraries
The first place GAUSS looks for a symbol definition is in the “active” libraries. A GAUSS library
is a text file that serves as a dictionary to the source files that contain the symbol definitions. When
a library is active, GAUSS will look in it whenever it is looking for a symbol it is trying to resolve.
The library statement is used to make a library active. Library files should be located in the
subdirectory listed in the lib_path configuration variable. Library files have an .lcg extension.
Suppose you have several procedures that are all related and you want them all defined in the same
file. You can create such a file, and, with the help of a library, the autoloader will be able to find
the procedures defined in that file whenever they are called.
First, create the file that is to contain your desired procedure definitions. By convention, this file is
usually named with a .src extension, but you may use any name and any file extension. In this
file, put all the definitions of related procedures you wish to use. Here is an example of such a file.
It is called norm.src:
norm.src
This is a file containing the definitions of three
procedures which return the norm of a matrix x.
The three norms calculated are the 1-norm, the
inf-norm and the E-norm.
Libraries
/*
**
**
**
**
**
**
*/
proc onenorm(x);
retp(maxc(sumc(abs(x))));
endp;
proc infnorm(x);
18-5
GAUSS User Guide
retp(maxc(sumc(abs(x’))));
endp;
proc Enorm(x);
retp(sumc(sumc(x.*x)));
endp;
Next, create a library file that contains the name of the file you want access to, and the list of
symbols defined in it. This can be done with the lib command. (For details, see lib in the
GAUSS L R.)
A library file entry has a filename that is flush left. The drive and path can be included to speed up
the autoloader. Indented below the filename are the symbols included in the file. There can be
multiple symbols listed on a line, with spaces between. The symbol type follows the symbol
name, with a colon delimiting it from the symbol name. The valid symbol types are:
fn
user-defined single line function.
keyword
keyword.
proc
procedure.
matrix
matrix, numeric or character.
array
N-dimensional array.
string
string.
sparse matrix
sparse matrix.
struct
structure.
A structure is always denoted by struct followed by the structure type name.
If the symbol type is missing, the colon must not be present and the symbol type is assumed to be
proc. Both library files below are valid:
Example 1
18-6
Libraries
/*
** math
**
** This library lists files and procedures for mathematical routines.
*/
norm.src
onenorm:proc infnorm:proc Enorm:proc
complex.src
cmmult:proc cmdiv:proc cmadd:proc cmsoln:proc
poly.src
polychar:proc polyroot:proc polymult:proc
Example 2
/*
** math
**
** This library lists files and procedures for mathematical routines.
*/
Libraries
c:\gauss\src\norm.src
onenorm : proc
infnorm : proc
Enorm : proc
c:\gauss\src\complex.src
cmmult : proc
cmdiv : proc
cmadd : proc
cmsoln : proc
c:\gauss\src\fcomp.src
feq : proc
fne : proc
flt : proc
fgt : proc
fle : proc
18-7
GAUSS User Guide
fge : proc
c:\gauss\src\fcomp.dec
_fcmptol : matrix
Once the autoloader finds, via the library, the file containing your procedure definition, everything
in that file will be compiled. For this reason, you should combine related procedures in the same
file in order to minimize the compiling of procedures not needed by your program. In other words,
you should not combine unrelated functions in one .src file because if one function in a .src file
is needed, the whole file will be compiled.
user Library
This is a library for user-created procedures. If the autoloader is ON, the user library is the first
place GAUSS looks when trying to resolve symbol references.
You can update the user library with the lib command as follows:
lib user myfile.src
This will update the user library by adding a reference to myfile.src.
No user library is shipped with GAUSS. It will be created the first time you use the lib
command to update it.
For details on the parameters available with the lib command, see the GAUSS L
R.
.g Files
If autoload and autodelete are ON and a symbol is not found in a library, the autoloader will
assume it is a procedure and look for a file that has the same name as the symbol and a .g
extension. For example, if you have defined a procedure called square, you could put the
definition in a file called square.g in one of the subdirectories listed in your src_path. If
autodelete is OFF, the .g file must be listed in an active library; for example, in the user library.
18-8
Libraries
18.2
Global Declaration Files
If your application makes use of several global variables, create a file containing declare
statements. Use files with the extension .dec to assign default values to global matrices and
strings with declare statements and to declare global N-dimensional arrays, sparse matrices,
and structures, which will be initialized as follows:
Variable Type
N-dimensional array
sparse matrix
structure
Initializes To
1-dimensional array of 1 containing 0
empty sparse matrix
1×1 structure containing empty and/or zeroed out members
In order to declare structures in a .dec file, you must #include the file(s) containing the
definitions of the types of structures that you wish to declare at the top of your .dec file. For
example, if you have the following structure type definition in a file called mystruct.sdf:
struct mystruct {
matrix m;
array a;
scalar scal;
string array sa;
};
You could declare an instance of that structure type, called ms, in a .dec file as follows:
#include mystruct.sdf
Libraries
declare struct mystruct ms;
See declare in the C R, Chapter 31, for more information.
A file with a .ext extension containing the same symbols in external statements can also be
created and #include’d at the top of any file that references these global variables. An
18-9
GAUSS User Guide
appropriate library file should contain the name of the .dec files and the names of the globals they
declare. This allows you to reference global variables across source files in an application.
Here is an example that illustrates the way in which .dec, .ext, .lcg and .src files work
together. Always begin the names of global matrices or strings with ‘_’ to distinguish them from
procedures.
.src File:
/*
** fcomp.src
**
** These functions use _fcmptol to fuzz the comparison operations
** to allow for roundoff error.
**
** The statement:
y = feq(a,b);
**
** is equivalent to:
y = a eq b;
**
** Returns a scalar result, 1 (true) or 0 (false)
**
**
y = feq(a,b);
**
y = fne(a,b);
*/
#include fcomp.ext;
proc feq(a,b);
retp(abs(a-b) <= _fcmptol);
endp;
proc fne(a,b);
retp(abs(a-b) > _fcmptol);
endp;
.dec File:
18-10
Libraries
/*
** fcomp.dec - global declaration file for fuzzy comparisons.
*/
declare matrix _fcmptol != 1e-14;
.ext File:
/*
** fcomp.ext - external declaration file for fuzzy comparisons.
*/
external matrix _fcmptol;
.lcg File:
/*
** fcomp.lcg - fuzzy compare library
*/
fcomp.dec
_fcmptol:matrix
fcomp.src
feq:proc
fne:proc
library fcomp;
x = rndn(3,3);
xi = inv(x);
18-11
Libraries
With the exception of the library (.lcg) files, these files must be located along your src_path.
The library files must be on your lib_path. With these files in place, the autoloader will be able
to find everything needed to run the following programs:
GAUSS User Guide
xix = xi*x;
if feq(xix,eye(3));
print "Inverse within tolerance.";
else;
print "Inverse not within tolerance.";
endif;
If the default tolerance of 1e-14 is too tight, the tolerance can be relaxed:
library fcomp;
x = rndn(3,3);
xi = inv(x);
xix = xi*x;
_fcmptol = 1e-12;
/* reset tolerance */
if feq(xix,eye(3));
print "Inverse within tolerance.";
else;
print "Inverse not within tolerance.";
endif;
18.3
Troubleshooting
Below is a partial list of errors you may encounter in using the library system, followed by the
most probable cause.
(4) :
error G0290 :
’/gauss/lib/prt.lcg’ :
Library not found
The autoloader is looking for a library file called prt.lcg, because it has been activated
in a library statement. Check the subdirectory listed in your lib_path configuration
variable for a file called prt.lcg.
(0) :
18-12
error G0292 :
’prt.dec’ :
File listed in library not found
Libraries
The autoloader cannot find a file called prt.dec. Check for this file. It should exist
somewhere along your src_path, if you have it listed in prt.lcg.
Undefined symbols:
PRTVEC /gauss/src/tstprt.g(2)
The symbol prtvec could not be found. Check if the file containing prtvec is in the
src_path. You may have not activated the library that contains your symbol definition.
Do so in a library statement.
/gauss/src/prt.dec(3) : Redefinition of ’__vnames’ (proc)__vnames being
declared external matrix
You are trying to illegally force a symbol to another type. You probably have a name
conflict that needs to be resolved by renaming one of the symbols.
/gauss/lib/prt.lcg(5) :
library
error G0301 :
’prt.dec’ :
Syntax error in
Undefined symbols:
__VNAMES /gauss/src/prt.src(6)
Check your library to see that all filenames are flush left and that all the symbols defined
in that file are indented by at least one space.
18.3.1
Using .dec Files
Below is some advice you are encouraged to follow when constructing your own library system:
• Provide a function containing regular assignment statements to reinitialize the global
variables in your program if they ever need to be reinitialized during or between runs. Put
this in a separate file from the declarations:
18-13
Libraries
• Whenever possible, declare variables in a file that contains only declare statements. When
your program is run again without clearing the workspace, the file containing the variable
declarations will not be compiled and declare warnings will be prevented.
GAUSS User Guide
proc (0) =
_vname
_con =
_row =
_title
endp;
globset;
= "X";
1;
0;
= "";
• Never declare any global in more than one file.
• To avoid meaningless redefinition errors and declare warnings, never declare a global
more than once in any one file. Redefinition error messages and declare warnings are
meant to help you prevent name conflicts, and will be useless to you if your code generates
them normally.
By following these guidelines, any declare warnings and redefinition errors you get will be
meaningful. By knowing that such warnings and errors are significant, you will be able to debug
your programs more efficiently.
18-14
Compiler
Compiler
19
GAUSS allows you to compile your large, frequently used programs to a file that can be run over
and over with no compile time. The compiled image is usually smaller than the uncompiled
source. GAUSS is not a native code compiler; rather, it compiles to a form of pseudocode. The file
will have a .gcg extension.
The compile command will compile an entire program to a compiled file. An attempt to edit a
compiled file will cause the source code to be loaded into the editor if it is available to the system.
The run command assumes a compiled file if no extension is given, and that a file with a .gcg
extension is in the src_path. A saveall command is available to save the current contents of
memory in a compiled file for instant recall later. The use command will instantly load a
compiled program or set of procedures at the beginning of an ASCII program before compiling the
rest of the ASCII program file.
Since the compiled files are encoded binary files, the compiler is useful for developers who do not
want to distribute their source code.
19-1
GAUSS User Guide
19.1
Compiling Programs
Programs are compiled with the compile command.
19.1.1
Compiling a File
Source code program files that can be run with the run command can be compiled to .gcg files
with the compile command:
compile qxy.e;
All procedures, global matrices, arrays, strings and string arrays, and the main program segment
will be saved in the compiled file. The compiled file can be run later using the run command. Any
libraries used in the program must be present and active during the compile, but not when the
program is run. If the program uses the dlibrary command, the .dll files must be present when
the program is run and the dlibrary path must be set to the correct subdirectory. This will be
handled automatically in your configuration file. If the program is run on a different computer than
it was compiled on, the .dll files must be present in the correct location. sysstate (case 24) can
be used to set the dlibrary path at run-time.
19.2
Saving the Current Workspace
The simplest way to create a compiled file containing a set of frequently used procedures is to use
saveall and an external statement:
library pgraph;
external proc xy,logx,logy,loglog,hist;
saveall pgraph;
Just list the procedures you will be using in an external statement and follow it with a saveall
statement. It is not necessary to list procedures that you do not explicitly call, but are called from
19-2
another procedure, because the autoloader will automatically find them before the saveall
command is executed. Nor is it necessary to list every procedure you will be calling, unless the
source will not be available when the compiled file is use’d.
Remember, the list of active libraries is NOT saved in the compiled file, so you may still need a
library statement in a program that is use’ing a compiled file.
19.3
Debugging
If you are using compiled code in a development situation in which debugging is important,
compile the file with line number records. After the development is over, you can recompile
without line number records if the maximum possible execution speed is important. If you want to
guarantee that all procedures contain line number records, put a new statement at the top of your
program and turn line number tracking on.
19-3
Compiler
Compiler
20
The following is a partial list of the I/O commands in the GAUSS programming language:
close
Close a file.
closeall
Close all open files.
colsf
Number of columns in a file.
create
Create GAUSS data set.
eof
Test for end of file.
fcheckerr
Check error status of a file.
fclearerr
Check error status of a file and clear error flag.
fflush
Flush a file’s output buffer.
fgets
Read a line of text from a file.
fgetsa
Read multiple lines of text from a file.
20-1
File I/O
File I/O
GAUSS User Guide
fgetsat
Read multiple lines of text from a file, discarding newlines.
fgetst
Read a line of text from a file, discarding newline.
fileinfo
Return names and information of files matching a specification.
files
Return a directory listing as a character matrix.
filesa
Return a list of files matching a specification.
fopen
Open a file.
fputs
Write strings to a file.
fputst
Write strings to a file, appending newlines.
fseek
Reposition file pointer.
fstrerror
Get explanation of last file I/O error.
ftell
Get position of file pointer.
getf
Load a file into a string.
getname
Get variable names from data set.
iscplxf
Return whether a data set is real or complex.
load
Load matrix file or small ASCII file (same as loadm).
loadd
Load a small GAUSS data set into a matrix.
loadm
Load matrix file or small ASCII file.
loads
Load string file.
open
Open a GAUSS data set.
output
Control printing to an auxiliary output file or device.
readr
Read a specified number of rows from a file.
rowsf
Number of rows in file.
save
Save matrices, strings, procedures.
20-2
File I/O
Save a matrix in a GAUSS data set.
seekr
Reset read/write pointer in a data set.
sortd
Sort a data set.
typef
Return type of data set (bytes per element).
writer
Write data to a data set.
20.1
File I/O
saved
ASCII Files
GAUSS has facilities for reading and writing ASCII files. Since most software can also read and
write ASCII files, this provides one method of sharing data between GAUSS and many other
kinds of programs.
20.1.1
Matrix Data
Reading
Files containing numeric data that are delimited with spaces or commas and are small enough to fit
into a single matrix or string can be read with load. Larger ASCII data files can be converted to
GAUSS data sets with the ATOG utility program (see ATOG, Chapter 26). ATOG can convert
packed ASCII files as well as delimited files.
For small delimited data files, the load statement can be used to load the data directly into a
GAUSS matrix. The resulting GAUSS matrix must be no larger than the limit for a single matrix.
For example,
load x[] = dat1.asc;
will load the data in the file dat1.asc into an N×1 matrix x. This method is preferred because
rows(x) can be used to determine how many elements were actually loaded, and the matrix can
be reshape’d to the desired form:
20-3
GAUSS User Guide
load x[] = dat1.asc;
if rows(x) eq 500;
x = reshape(x,100,5);
else;
errorlog "Read Error";
end;
endif;
For quick interactive loading without error checking, use
load x[100,5] = dat1.asc;
This will load the data into a 100×5 matrix. If there are more or fewer than 500 numbers in the
data set, the matrix will automatically be reshaped to 100×5.
Writing
To write data to an ASCII file the print or printfm command is used to print to the auxiliary
output. The resulting files are standard ASCII files and can be edited with GAUSS’s editor or
another text editor.
The output and outwidth commands are used to control the auxiliary output. The print or
printfm command is used to control what is sent to the output file.
The window can be turned on and off using screen. When printing a large amount of data to the
auxiliary output, the window can be turned off using the command
screen off;
This will make the process much faster, especially if the auxiliary output is a disk file.
It is easy to forget to turn the window on again. Use the end statement to terminate your
programs; end will automatically perform screen on and output off.
The following commands can be used to control printing to the auxiliary output:
20-4
File I/O
Specify format for printing a matrix.
output
Open, close, rename auxiliary output file or device.
outwidth
Set auxiliary output width.
printfm
Formatted matrix print.
print
Print matrix or string.
screen
Turn printing to the window on and off.
File I/O
format
This example illustrates printing a matrix to a file:
format /rd 8,2;
outwidth 132;
output file = myfile.asc reset;
screen off;
print x;
output off;
screen on;
The numbers in the matrix x will be printed with a field width of 8 spaces per number, and with 2
places beyond the decimal point. The resulting file will be an ASCII data file. It will have 132
column lines maximum.
A more extended example follows. This program will write the contents of the GAUSS file
mydata.dat into an ASCII file called mydata.asc. If there is an existing file by the name of
mydata.asc, it will be overwritten:
output file = mydata.asc reset;
screen off;
format /rd 1,8;
open fp = mydata;
do until eof(fp);
print readr(fp,200);;
20-5
GAUSS User Guide
endo;
fp = close(fp);
end;
The output ... reset command will create an auxiliary output file called mydata.asc to
receive the output. The window is turned off to speed up the process. The GAUSS data file
mydata.dat is opened for reading and 200 rows are read per iteration until the end of the file is
reached. The data read are printed to the auxiliary output mydata.asc only, because the window
is off.
20.1.2
General File I/O
getf will read a file and return it in a string variable. Any kind of file can be read in this way as
long as it will fit into a single string variable.
To read files sequentially, use fopen to open the file and use fgets, fputs, and associated
functions to read and write the file. The current position in a file can be determined with ftell.
The following example uses these functions to copy an ASCII text file:
proc copy(src, dest);
local fin, fout, str;
fin = fopen(src, "rb");
if not fin;
retp(1);
endif;
fout = fopen(dest, "wb");
if not fin;
call close(fin);
retp(2);
endif;
do until eof(fin);
20-6
File I/O
File I/O
str = fgets(fin, 1024);
if fputs(fout, str) /= 1;
call close(fin);
call close(fout);
retp(3);
endif;
endo;
call close(fin);
call close(fout);
retp(0);
endp;
20.2
Data Sets
GAUSS data sets are the preferred method of storing data contained in a single matrix for use
within GAUSS. Use of these data sets allows extremely fast reading and writing of data. Many
library functions are designed to read data from these data sets.
If you want to store multiple variables of various types in a single file, see GAUSS D A,
Section 20.3.
20.2.1
Layout
GAUSS data sets are arranged as matrices; that is, they are organized in terms of rows and
columns. The columns in a data file are assigned names, and these names are stored in the header,
or, in the case of the v89 format, in a separate header file.
The limit on the number of rows in a GAUSS data set is determined by disk size. The limit on the
number of columns is limited by RAM. Data can be stored in 2, 4, or 8 bytes per number, rather
than just 8 bytes as in the case of GAUSS matrix files.
The ranges of the different formats are:
20-7
GAUSS User Guide
Bytes
Type
Significant
Digits
2
4
8
integer
single
double
4
6-7
15-16
20.2.2
Range
-32768 <= X <= 32767
8.43E-37 <= |X| <= 3.37E+38
4.19E-307 <= |X| <= 1.67E+308
Creating Data Sets
Data sets can be created with the create or datacreate command. The names of the columns,
the type of data, etc., can be specified. (For details, see create in the GAUSS L
R.)
Data sets, unlike matrices, cannot change from real to complex, or vice-versa. Data sets are always
stored a row at a time. The rows of a complex data set, then, have the real and imaginary parts
interleaved, element by element. For this reason, you cannot write rows from a complex matrix to
a real data set—there is no way to interleave the data without rewriting the entire data set. If you
must, explicitly convert the rows of data first, using the real and imag functions (see the GAUSS
L R), and then write them to the data set. Rows from a real matrix CAN be
written to a complex data set; GAUSS simply supplies 0’s for the imaginary part.
To create a complex data set, include the complex flag in your create command.
20.2.3
Reading and Writing
The basic functions in GAUSS for reading data files are open and readr:
open f1 = dat1;
x = readr(f1,100);
The call to readr in this example will read in 100 rows from dat1.dat. The data will be assigned
to a matrix x.
loadd and saved can be used for loading and saving small data sets.
20-8
File I/O
The following example illustrates the creation of a GAUSS data file by merging (horizontally
concatenating) two existing data sets:
File I/O
file1 = "dat1";
file2 = "dat2";
outfile = "daty";
open fin1 = ˆfile1 for read;
open fin2 = ˆfile2 for read;
varnames = getname(file1)|getname(file2);
otyp = maxc(typef(fin1)|typef(fin2));
create fout = ˆoutfile with ˆvarnames,0,otyp;
nr = 400;
do until eof(fin1) or eof(fin2);
y1 = readr(fin1,nr);
y2 = readr(fin2,nr);
r = maxc(rows(y1)|rows(y2));
y = y1[1:r,.] ˜ y2[1:r,.];
call writer(fout,y);
endo;
closeall fin1,fin2,fout;
In this example, data sets dat1.dat and dat2.dat are opened for reading. The variable names
from each data set are read using getname, and combined in a single vector called varnames. A
variable called otyp is created, which will be equal to the larger of the two data types of the input
files. This will insure that the output is not rounded to less precision than the input files. A new
data set daty.dat is created using the create ... with ... command. Then, on every
iteration of the loop, 400 rows are read in from each of the two input data sets, horizontally
concatenated, and written out to daty.dat. When the end of one of the input files is reached,
reading and writing will stop. The closeall command is used to close all files.
20.2.4
Distinguishing Character and Numeric Data
Although GAUSS itself does not distinguish between numeric and character columns in a matrix
or data set, some of the GAUSS Application programs do. When creating a data set, it is important
to indicate the type of data in the various columns. The following discusses two ways of doing this.
20-9
GAUSS User Guide
Using Type Vectors
The v89 data set format distinguished between character and numeric data in data sets by the case
of the variable names associated with the columns. The v96 data set format, however, stores this
type information separately, resulting in a much cleaner and more robust method of tracking
variable types, and greater freedom in the naming of data set variables.
When you create a data set, you can supply a vector indicating the type of data in each column of
the data set. For example:
data = { M 32 21500,
F 27 36000,
F 28 19500,
M 25 32000 };
vnames = { "Sex" "Age" "Pay" };
vtypes = { 0 1 1 };
create f = mydata with ˆvnames, 3, 8, vtypes;
call writer(f,data);
f = close(f);
To retrieve the type vector, use vartypef.
open f = mydata for read;
vn = getnamef(f);
vt = vartypef(f);
print vn’;
print vt’;
Sex
0
Age
1
Pay
1
The call to getnamef in this example returns a string array rather than a character vector, so you
can print it without the ‘$’ prefix.
20-10
File I/O
Using the Uppercase/Lowercase Convention (v89 Data Sets)
However, this is now obsolete; use vartypef and v96 data sets to be compatible with future
versions.
20.3
GAUSS Data Archives
The GAUSS Data Archive (GDA) is extremely powerful and flexible, giving you much greater
control over how you store your data. There is no limitation on the number of variables that can be
stored in a GDA, and the only size limitation is the amount of available disk space. Moreover,
GDA’s are designed to hold whatever type of data you want to store in them. You may write
matrices, arrays, strings, string arrays, sparse matrices, and structures to a GDA, and the GDA will
keep track of the type, size and location of each of the variables contained in it. Since GAUSS
now supports reading and writing to GDA’s that were created on other platforms, GDA’s provide a
simple solution to the problem of sharing data across platforms.
See Section 20.5.12 for information on the layout of a GDA.
20.3.1
Creating and Writing Variables to GDA’s
To create a GAUSS Data Archive, call gdaCreate, which creates a GDA containing only header
information. It is recommended that file names passed into gdaCreate have a .gda extension;
however, gdaCreate will not force an extension.
To write variables to the GDA, you must call gdaWrite. A single call to gdaWrite writes only
one variable to the GDA. Writing multiple variables requires multiple calls to gdaWrite.
For example, the following code:
ret = gdaCreate("myfile.gda",1);
20-11
File I/O
Historically, some GAUSS Application programs recognized an “uppercase/lowercase”
convention: if the variable name was uppercase, the variable was assumed to be numeric, and if it
was lowercase, the variable was assumed to be character.
GAUSS User Guide
ret = gdaWrite("myfile.gda",rndn(100,50),"x1");
ret = gdaWrite("myfile.gda","This is a string","str1");
ret = gdaWrite("myfile.gda",394,"x2");
produces a GDA containing the following variables:
Index
1
2
3
20.3.2
Name
x1
str1
x2
Type
matrix
string
matrix
Size
100 × 50
16 chars
1×1
Reading Variables from GDA’s
The following table details the commands that you may use to read various types of variables from
a GAUSS Data Archive:
Variable Type
matrix
array
string
string array
sparse matrix
structure
Read Command(s)
gdaRead
gdaReadByIndex
gdaReadSparse
gdaReadStruct
gdaRead, gdaReadSparse, and gdaReadStruct take a variable name and return the variable
data. gdaReadByIndex returns the variable data for a specified variable index.
For example, to get the variable x1 out of myfile.gda, you could call:
y = gdaRead("myfile.gda","x1");
or
y = gdaReadByIndex("myfile.gda",1);
20-12
File I/O
If you want to read only a part of a matrix, array, string, or string array from a GDA, call
gdaReadSome. Sparse matrices and structures may not be read in parts.
Updating Variables in GDA’s
To overwrite an entire variable in a GDA, you may call gdaUpdate or gdaUpdateAndPack. If the
new variable is not the same size as the variable that it is replacing, gdaUpdate will leave empty
bytes in the file, while gdaUpdateAndPack will pack the file (from the location of the variable
that is being replaced to the end of the file) to remove those empty bytes.
gdaUpdate is usually faster, since it does not move data in the file unnecessarily. However, calling
gdaUpdate several times for one file may result in a file with a large number of empty bytes.
On the other hand, gdaUpdateAndPack uses disk space efficiently, but it may be slow for large
files (especially if the variable to be updated is one of the first variables in the file).
If speed and disk space are both concerns and you are going to update several variables, it will be
most efficient to use gdaUpdate to update the variables and then call gdaPack once at the end to
pack the file.
The syntax is the same for both gdaUpdate and gdaUpdateAndPack:
ret = gdaUpdate("myfile.gda",rndn(1000,100),"x1");
ret = gdaUpdateAndPack("myfile.gda",rndn(1000,100),"x1");
To overwrite part of a variable in a GDA, call gdaWriteSome.
20.4
Matrix Files
GAUSS matrix files are files created by the save command.
20-13
File I/O
20.3.3
GAUSS User Guide
The save command takes a matrix in memory, adds a header that contains information on the
number of rows and columns in the matrix, and stores it on disk. Numbers are stored in double
precision just as they are in matrices in memory. These files have the extension .fmt.
Matrix files can be no larger than a single matrix. No variable names are associated with matrix
files.
GAUSS matrix files can be load’ed into memory using the load or loadm command or they can
be opened with the open command and read with the readr command. With the readr
command, a subset of the rows can be read. With the load command, the entire matrix is load’ed.
GAUSS matrix files can be open’ed for read, but not for append, or for update.
If a matrix file has been opened and assigned a file handle, rowsf and colsf can be used to
determine how many rows and columns it has without actually reading it into memory. seekr and
readr can be used to jump to particular rows and to read them into memory. This is useful when
only a subset of rows is needed at any time. This procedure will save memory and be much faster
than load’ing the entire matrix into memory.
20.5
File Formats
This section discusses the GAUSS binary file formats.
There are four currently supported matrix file formats:
Version
Extension
Support
Small Matrix v89
Extended Matrix v89
Matrix v92
Universal Matrix v96
.fmt
.fmt
.fmt
.fmt
Obsolete, use v96.
Obsolete, use v96.
Obsolete, use v96.
Supported for read/write.
There are four currently supported string file formats:
20-14
File I/O
Extension
Support
Small String v89
Extended String v89
String v92
Universal String v96
.fst
.fst
.fst
.fst
Obsolete, use v96.
Obsolete, use v96.
Obsolete, use v96.
Supported for read/write.
File I/O
Version
There are four currently supported data set formats:
Version
Extension
Small Data Set v89
.dat,
Obsolete, use v96.
.dht
.dat,
Obsolete, use v96.
.dht
.dat Obsolete, use v96.
.dat Supported for read/write.
Extended Data Set v89
Data Set v92
Universal Data Set v96
20.5.1
Support
Small Matrix v89 (Obsolete)
Matrix files are binary files, and cannot be read with a text editor. They are created with save.
Matrix files with up to 8190 elements have a .fmt extension and a 16-byte header formatted as
follows:
Offset
Description
0-1
2-3
4-5
6-7
8-9
10-15
DDDD hex, identification flag
rows, unsigned 2-byte integer
columns, unsigned 2-byte integer
size of file minus 16-byte header, unsigned 2-byte integer
type of file, 0086 hex for real matrices, 8086 hex for complex matrices
reserved, all 0’s
The body of the file starts at offset 16 and consists of IEEE format double precision floating point
numbers or character elements of up to 8 characters. Character elements take up 8 bytes and are
padded on the right with zeros. The size of the body of the file is 8*rows*cols rounded up to the
next 16-byte paragraph boundary. Numbers are stored row by row. A 2×3 real matrix will be
20-15
GAUSS User Guide
stored on disk in the following way, from the lowest addressed element to the highest addressed
element:
[1, 1] [1, 2] [1, 3] [2, 1] [2, 2] [2, 3]
For complex matrices, the size of the body of the file is 16*rows*cols. The entire real part of the
matrix is stored first, then the entire imaginary part. A 2×3 complex matrix will be stored on disk
in the following way, from the lowest addressed element to the highest addressed element:
(real part)
[1, 1] [1, 2] [1, 3] [2, 1] [2, 2] [2, 3]
(imaginary part) [1, 1] [1, 2] [1, 3] [2, 1] [2, 2] [2, 3]
20.5.2
Extended Matrix v89 (Obsolete)
Matrices with more than 8190 elements are saved in an extended format. These files have a
16-byte header formatted as follows:
Offset
Description
0-1
2-3
4-7
8-11
12-15
EEDD hex, identification flag
type of file, 0086 hex for real matrices, 8086 hex for complex matrices
rows, unsigned 4-byte integer
columns, unsigned 4-byte integer
size of file minus 16-byte header, unsigned 4-byte integer
The size of the body of an extended matrix file is 8*rows*cols (not rounded up to a paragraph
boundary). Aside from this, the body is the same as the small matrix v89 file.
20.5.3
Small String v89 (Obsolete)
String files are created with save. String files with up to 65519 characters have a 16-byte header
formatted as follows:
20-16
File I/O
Description
0-1
2-3
4-5
6-7
8-9
10-15
DFDF hex, identification flag
1, unsigned 2-byte integer
length of string plus null byte, unsigned 2-byte integer
size of file minus 16-byte header, unsigned 2-byte integer
001D hex, type of file
reserved, all 0’s
File I/O
Offset
The body of the file starts at offset 16. It consists of the string terminated with a null byte. The size
of the file is the 16-byte header plus the length of the string and null byte rounded up to the next
16-byte paragraph boundary.
20.5.4
Extended String v89 (Obsolete)
Strings with more than 65519 characters are saved in an extended format. These files have a
16-byte header formatted as follows:
Offset
Description
0-1
2-3
4-7
8-11
12-15
EEDF hex, identification flag
001D hex, type of file
1, unsigned 4-byte integer
length of string plus null byte, unsigned 4-byte integer
size of file minus 16-byte header, unsigned 4-byte integer
The body of the file starts at offset 16. It consists of the string terminated with a null byte. The size
of the file is the 16-byte header plus the length of the string and null byte rounded up to the next
8-byte boundary.
20.5.5
Small Data Set v89 (Obsolete)
All data sets are created with create. v89 data sets consist of two files; one .dht contains the
header information; the second (.dat) contains the binary data. The data will be one of three types:
20-17
GAUSS User Guide
8-byte IEEE floating point
4-byte IEEE floating point
2-byte signed binary integer, twos complement
Numbers are stored row by row.
The .dht file is used in conjunction with the .dat file as a descriptor file and as a place to store
names for the columns in the .dat file. Data sets with up to 8175 columns have a .dht file
formatted as follows:
Offset
Description
0-1
2-5
6-7
8-9
10-11
12-13
14-17
18-21
22-23
24-127
DADA hex, identification flag
reserved, all 0’s
columns, unsigned 2-byte integer
row size in bytes, unsigned 2-byte integer
header size in bytes, unsigned 2-byte integer
data type in .dat file (2 4 8), unsigned 2-byte integer
reserved, all 0’s
reserved, all 0’s
control flags, unsigned 2-byte integer
reserved, all 0’s
Column names begin at offset 128 and are stored 8 bytes each in ASCII format. Names with less
than 8 characters are padded on the right with bytes of 0.
The number of rows in the .dat file is calculated in GAUSS using the file size, columns, and data
type. This means that users can modify the .dat file by adding or deleting rows with other
software without updating the header information.
Names for the columns should be lowercase for character data, to be able to distinguish them from
numeric data with vartype.
GAUSS currently examines only the 4’s bit of the control flags. This bit is set to 0 for real data
sets, 1 for complex data sets. All other bits are 0.
Data sets are always stored a row at a time. A real data set with 2 rows and 3 columns will be
stored on disk in the following way, from the lowest addressed element to the highest addressed
20-18
File I/O
element:
File I/O
[1, 1] [1, 2] [1, 3]
[2, 1] [2, 2] [2, 3]
The rows of a complex data set are stored with the real and imaginary parts interleaved, element
by element. A 2×3 complex data set, then, will be stored on disk in the following way, from the
lowest addressed element to the highest addressed element:
[1, 1]r [1, 1]i [1, 2]r [1, 2]i [1, 3]r [1, 3]i
[2, 1]r [2, 1]i [2, 2]r [2, 2]i [2, 3]r [2, 3]i
20.5.6
Extended Data Set v89 (Obsolete)
Data sets with more than 8175 columns are saved in an extended format that cannot be read by the
16-bit version. These files have a .dht descriptor file formatted as follows:
Offset
Description
0-1
2-3
4-7
8-11
12-15
16-19
20-23
24-27
28-29
30-127
EEDA hex, identification flag
data type in .dat file (2 4 8), unsigned 2-byte integer
reserved, all 0’s
columns, unsigned 4-byte integer
row size in bytes, unsigned 4-byte integer
header size in bytes, unsigned 4-byte integer
reserved, all 0’s
reserved, all 0’s
control flags, unsigned 2-byte integer
reserved, all 0’s
Aside from the differences in the descriptor file and the number of columns allowed in the data
file, extended data sets conform to the v89 data set description specified above.
20-19
GAUSS User Guide
20.5.7
Matrix v92 (Obsolete)
Offset
Description
0-3
4-7
8-11
12-15
16-19
20-23
24-27
always 0
always 0xEECDCDCD
reserved
reserved
reserved
0 - real matrix, 1 - complex matrix
number of dimensions
0 - scalar
1 - row vector
2 - column vector, matrix
header size, 128 + number of dimensions * 4, padded to 8-byte boundary
reserved
28-31
32-127
If the data is a scalar, the data will directly follow the header.
If the data is a row vector, an unsigned integer equaling the number of columns in the vector will
precede the data, along with 4 padding bytes.
If the data is a column vector or a matrix, there will be two unsigned integers preceding the data.
The first will represent the number of rows in the matrix and the second will represent the number
of columns.
The data area always begins on an even 8-byte boundary. Numbers are stored in double precision
(8 bytes per element, 16 if complex). For complex matrices, all of the real parts are stored first,
followed by all the imaginary parts.
20.5.8
String v92 (Obsolete)
Offset
Description
0-3
4-7
always 0
always 0xEECFCFCF
20-20
File I/O
Description
8-11
12-15
16-19
20-23
24-27
28-127
reserved
reserved
reserved
size of string in units of 8 bytes
length of string plus null terminator in bytes
reserved
File I/O
Offset
The size of the data area is always divisible by 8, and is padded with nulls if the length of the string
is not evenly divisible by 8. If the length of the string is evenly divisible by 8, the data area will be
the length of the string plus 8. The data area follows immediately after the 128-byte header.
20.5.9
Data Set v92 (Obsolete)
Offset
Description
0-3
4-7
8-11
12-15
16-19
20-23
24-27
28-31
32-35
36-39
40-127
always 0
always 0xEECACACA
reserved
reserved
reserved
rows in data set
columns in data set
0 - real data set, 1 - complex data set
type of data in data set, 2, 4, or 8
header size in bytes is 128 + columns * 9
reserved
The variable names begin at offset 128 and are stored 8 bytes each in ASCII format. Each name
corresponds to one column of data. Names less than 8 characters are padded on the right with
bytes of zero.
The variable type flags immediately follow the variable names. They are 1-byte binary integers,
one per column, padded to an even 8-byte boundary. A 1 indicates a numeric variable and a 0
indicates a character variable.
20-21
GAUSS User Guide
The contents of the data set follow the header and start on an 8-byte boundary. Data is either 2-byte
signed integer, 4-byte single precision floating point or 8-byte double precision floating point.
20.5.10
Offset
Matrix v96
Description
0-3
4-7
8-11
12-15
16-19
20-23
24-27
28-31
32-35
36-39
40-43
44-47
48-51
52-55
56-59
always 0xFFFFFFFF
always 0
always 0xFFFFFFFF
always 0
always 0xFFFFFFFF
0xFFFFFFFF for forward byte order, 0 for backward byte order
0xFFFFFFFF for forward bit order, 0 for backward bit order
always 0xABCDEF01
currently 1
reserved
floating point type, 1 for IEEE 754
1008 (double precision data)
8, the size in bytes of a double matrix
0 - real matrix, 1 - complex matrix
1 - imaginary part of matrix follows real part (standard GAUSS style)
2 - imaginary part of each element immediately follows real part
(FORTRAN style)
60-63
number of dimensions
0 - scalar
1 - row vector
2 - column vector or matrix
64-67
1 - row major ordering of elements, 2 - column major
68-71
always 0
72-75
header size, 128 + dimensions * 4, padded to 8-byte boundary
76-127 reserved
If the data is a scalar, the data will directly follow the header.
If the data is a row vector, an unsigned integer equaling the number of columns in the vector will
20-22
File I/O
precede the data, along with 4 padding bytes.
The data area always begins on an even 8-byte boundary. Numbers are stored in double precision
(8 bytes per element, 16 if complex). For complex matrices, all of the real parts are stored first,
followed by all the imaginary parts.
20.5.11
Data Set v96
Offset
Description
0-3
4-7
8-11
12-15
16-19
20-23
24-27
28-31
32-35
36-39
40-43
44-47
always 0xFFFFFFFF
always 0
always 0xFFFFFFFF
always 0
always 0xFFFFFFFF
0xFFFFFFFF for forward byte order, 0 for backward byte order
0xFFFFFFFF for forward bit order, 0 for backward bit order
0xABCDEF02
version, currently 1
reserved
floating point type, 1 for IEEE 754
12 - signed 2-byte integer
1004 - single precision floating point
1008 - double precision float
2, 4, or 8, the size of an element in bytes
0 - real matrix, 1 - complex matrix
1 - imaginary part of matrix follows real part (standard GAUSS style)
2 - imaginary part of each element immediately follows real part
(FORTRAN style)
always 2
1 for row major ordering of elements, 2 for column major
always 0
48-51
52-55
56-59
60-63
64-67
68-71
20-23
File I/O
If the data is a column vector or a matrix, there will be two unsigned integers preceding the data.
The first will represent the number of rows in the matrix and the second will represent the number
of columns.
GAUSS User Guide
Offset
Description
72-75
76-79
80-83
84-87
88-127
header size, 128 + columns * 33, padded to 8-byte boundary
reserved
rows in data set
columns in data set
reserved
The variable names begin at offset 128 and are stored 32 bytes each in ASCII format. Each name
corresponds to one column of data. Names less than 32 characters are padded on the right with
bytes of zero.
The variable type flags immediately follow the variable names. They are 1-byte binary integers,
one per column, padded to an even 8-byte boundary. A 1 indicates a numeric variable and a 0
indicates a character variable.
Contents of the data set follow the header and start on an 8-byte boundary. Data is either 2-byte
signed integer, 4-byte single precision floating point or 8-byte double precision floating point.
20.5.12
GAUSS Data Archive
A GAUSS Data Archive consists of a header, followed by the variable data and, finally, an array of
variable descriptors containing information about each variable.
Header
The header for a GAUSS Data Archive is laid out as follows:
Offset
0-3
4-7
8-11
12-15
16-19
20-24
Type
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integer
Description
always 0xFFFFFFFF
always 0
always 0xFFFFFFFF
always 0
always 0xFFFFFFFF
File I/O
Type
32-bit unsigned integer
24-27
28-31
32-35
36-39
40-43
44-55
56-63
64-67
68-95
96-103
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integers
64-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integers
64-bit unsigned integer
104-127
64-bit unsigned integers
Description
0xFFFFFFFF for forward byte order,
0 for backward byte order
always 0
always 0xABCDEF08
version, currently 1
reserved
floating point type, 1 for IEEE 754
reserved
number of variables
header size, 128
reserved
offset of variable descriptor table from
end of header
reserved
File I/O
Offset
20-23
Variable Data
After the header comes the variable data. Matrices are laid out in row-major order, and strings are
written with a null-terminating byte.
For string arrays, an array of rows×columns struct satable’s is written out first, followed by the
string array data in row-major order with each element null terminated. A struct satable consists
of two members:
Member
off
len
Type
size_t
size_t
Description
offset of element data from beginning of string array data
length of element data, including null-terminating byte
On a 32-bit machine, a size_t is 4 bytes. On a 64-bit machine, it is 8 bytes.
Arrays are written with the orders (sizes) of each dimension followed by the array data. For
example, the following 2×3×4 array:
20-25
GAUSS User Guide
[1,1,1] through [1,3,4] =
1 2 3 4
5 6 7 8
9 10 11 12
[2,1,1] through [2,3,4] =
13 14 15 16
17 18 19 20
21 22 23 24
would be written out like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
Variable Structures
The variable data is followed by an array of variable descriptors. For each variable in the GDA,
there is a corresponding variable descriptor in this array. A variable descriptor is laid out as
follows:
Offset
0-3
4-7
8-11
12-15
16-19
Type
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integer
32-bit unsigned integer
20-23
32-bit unsigned integer
24-31
64-bit unsigned integer
20-26
Description
variable type
data type, 10 for 8 byte floating point
dimensions, used only for arrays
complex flag, 1 for real data, 0 for complex
size of pointer, indicates whether the variable
was written on a 32-bit or 64-bit platform
huge flag, indicates whether the variable is
larger than INT MAX
rows for matrices and string arrays
File I/O
Type
64-bit unsigned integer
40-47
48-55
56-63
64-143
64-bit unsigned integer
64-bit unsigned integer
64-bit unsigned integer
string
Description
columns for matrices and string arrays,
length for strings, including null-terminating byte
index of the variable in the GDA
offset of variable data from end of header
length of variable data in bytes
name of variable, null-terminated
File I/O
Offset
32-39
The variable type (bytes 0-3) may be any of the following:
20
30
40
50
array
matrix
string
string array
The size of pointer element (bytes 16-19) is the size of a pointer on the machine on which the
variable was written to the GDA. It will be set to 4 on 32-bit machines and 8 on 64-bit machines.
This element is used only for string array variables. If a GDA containing string arrays is created
on a 32-bit machine and then read on a 64-bit machine, or vice versa, then the size of pointer
element indicates how the members of the struct satable’s must be converted in order to be read
on the current machine.
The huge flag (bytes 20-23) is set to 1 if the variable size is greater than INT MAX, which is
defined as 2147483647. A variable for which the huge flag is set to 1 may not be read into GAUSS
on a 32-bit machine.
The variable index element (bytes 40-47) contains the index of the variable in the GDA. Although
the variable data is not necessarily ordered by index (see gdaUpdate), the variable descriptors are.
Therefore, the indices are always in ascending order.
20-27
Foreign Language Interface
The Foreign Language Interface (FLI) allows users to create functions written in C, FORTRAN, or
other languages, and call them from a GAUSS program. The functions are placed in dynamic
libraries (DLLs, also known as shared libraries or shared objects) and linked in at run-time as
needed. The FLI functions are:
dlibrary
Link and unlink dynamic libraries at run-time.
dllcall
Call functions located in dynamic libraries.
GAUSS recognizes a default dynamic library directory, a directory where it will look for your
dynamic-link libraries when you call dlibrary. You can specify the default directory in
gauss.cfg by setting dlib_path. As it is shipped, gauss.cfg specifies $(GAUSSDIR)/dlib as
the default directory.
21-1
FLI
21
GAUSS User Guide
21.1
Writing FLI Functions
Your FLI functions should be written to the following specifications:
1. Take 0 or more pointers to doubles as arguments.
This does not mean you cannot pass strings to an FLI function. Just recast the double
pointer to a char pointer inside the function.
2. Take those arguments either in a list or a vector.
3. Return an integer.
In C syntax, then, your functions would take one of the following forms:
1. int func(void);
2. int func(double *arg1 [[,double *arg2,. . .]]);
3. int func(double *arg[]);
Functions can be written to take a list of up to 100 arguments, or a vector (in C terms, a
1-dimensional array) of up to 1000 arguments. This does not affect how the function is called from
GAUSS; the dllcall statement will always appear to pass the arguments in a list. That is, the
dllcall statement will always look as follows:
dllcall func(a,b,c,d[[,e...]]);
For details on calling your function, passing arguments to it, getting data back, and what the return
value means, see dllcall in the GAUSS L R.
21-2
Foreign Language Interface
21.2
Creating Dynamic Libraries
The following describes how to build a dynamic library called hyp.dll (on Windows) or
libhyp.so (on UNIX/Linux) from the source file hyp.c.
As mentioned in the previous section, your FLI functions may take only pointers to doubles as
arguments. Therefore, you should define your FLI functions to be merely wrapper functions that
cast their arguments as necessary and then call the functions that actually do the work. This is
demonstrated in the source file hyp.c:
FLI
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
/* This code is not meant to be efficient. It is meant
** to demonstrate the use of the FLI.
*/
/* this does all the work, not exported */
static int hypo(double *x, double *y, double *h, int r, int c)
{
double *wx;
double *wy;
double *dp;
double *sp1;
double *sp2;
int i, elems;
elems = r*c;
/* malloc work arrays */
if ((wx = (double *)malloc(elems*sizeof(double))) =\,= NULL)
return 30;
/* out of memory */
if ((wy = (double *)malloc(elems*sizeof(double))) =\,= NULL)
{
21-3
GAUSS User Guide
free(wx);
return 30;
/* out of memory */
}
dp = wx;
sp1 = x;
/* square x into work area wx */
for (i=0; i<elems; i++)
{
*dp = *sp1 * *sp1;
++sp1;
++dp;
}
dp = wy;
sp2 = y;
/* square y into work area wy */
for (i=0; i<elems; i++)
{
*dp = *sp2 * *sp2;
++sp2;
++dp;
}
dp = h;
sp1 = wx;
sp2 = wy;
/* compute hypotenuse into h which was allocated by GAUSS */
for (i=0; i<elems; i++)
{
*dp = sqrt(*sp1 + *sp2);
++sp1;
++sp2;
++dp;
21-4
Foreign Language Interface
}
/* free whatever you malloc */
free(wx);
free(wy);
return 0;
}
FLI
/* exported wrapper, all double * arguments, calls the real
** function with whatever data types it expects
*/
int hypotenuse(double *x, double *y, double *h,
double *r, double *c)
{
return hypo( x, y, h, (int)*r, (int)*c );
}
The following Makefiles contain the compile and link commands you would use to build the
dynamic library on various platforms. For explanations of the various flags used, see the
documentation for your compiler and linker.
Windows
hyp.dll: hyp.obj
link /dll /out:hyp.dll hyp.obj
hyp.obj: hyp.c
cl -c -MD -GX hyp.c
Solaris
$(CCOPTS) indicates any optional compilation flags you might add.
21-5
GAUSS User Guide
CCOPTIONS = -g -xsb -xarch=v9 -KPIC
CC = cc
libhyp.so: hyp.c
$(CC) -G $(CCOPTIONS) -o $@ hyp.c -lm
Linux
$(CCOPTS) indicates any optional compilation flags you might add.
CCOPTIONS = -g -O2 -lm -lc -shared
CC = gcc
libhyp.so: hyp.cpp
$(CC) $(CCOPTIONS) -o $@ hyp.c
For details on linking your dynamic library, see dlibrary in the GAUSS L R.
21-6
Data Transformations
22
dataloop infile outfile;
drop wagefac wqlec shordelt foobly;
csed = ln(sqrt(csed));
select csed > 0.35 and married $=\,= "y";
make chfac = hcfac + wcfac;
keep csed chfac stid recsum voom;
endata;
GAUSS translates the data loop into a procedure that performs the required operations, and then
calls the procedure automatically at the location (in your program) of the data loop. It does this by
translating your main program file into a temporary file and then executing the temporary file.
A data loop may be placed only in the main program file. Data loops in files that are #include’d
or autoloaded are not recognized.
22-1
Data Loop
GAUSS allows expressions that directly reference variables (columns) of a data set. This is done
within the context of a data loop:
GAUSS User Guide
22.1
Data Loop Statements
A data loop begins with a dataloop statement and ends with an endata statement. Inside a data
loop, the following statements are supported:
code
Create variable based on a set of logical expressions.
delete
Delete rows (observations) based on a logical expression.
drop
Specify variables NOT to be written to data set.
extern
Allow access to matrices and strings in memory.
keep
Specify variables to be written to output data set.
lag
Lag variables a number of periods.
listwise
Control deletion of missing values.
make
Create new variable.
outtyp
Specify output file precision.
recode
Change variable based on a set of logical expressions.
select
Select rows (observations) based on a logical expression.
vector
Create new variable from a scalar returning expression.
In any expression inside a data loop, all text symbols not immediately followed by a left
parenthesis ‘(’ are assumed to be data set variable (column) names. Text symbols followed by a
left parenthesis are assumed to be procedure names. Any symbol listed in an extern statement is
assumed to be a matrix or string already in memory.
22-2
Data Transformations
22.2
Using Other Statements
All program statements in the main file and not inside a data loop are passed through to the
temporary file without modification. Program statements within a data loop that are preceded by a
‘#’ are passed through to the temporary file without modification. The user familiar with the code
generated in the temporary file can use this to do out-of-the-ordinary operations inside the data
loop.
22.3
Debugging Data Loops
The translator that processes data loops can be turned on and off. When the translator is on, there
are three distinct phases in running a program:
Translation of main program file to temporary file.
Compilation
Compilation of temporary file.
Execution
Execution of compiled code.
22.3.1
Data Loop
Translation
Translation Phase
In the translation phase, the main program file is translated into a temporary file. Each data loop is
translated into a procedure and a call to this procedure is placed in the temporary file at the same
location as the original data loop. The data loop itself is commented out in the temporary file. All
the data loop procedures are placed at the end of the temporary file.
Depending upon the status of line number tracking, error messages encountered in this phase will
be printed with the file name and line numbers corresponding to the main file.
22.3.2
Compilation Phase
In the compilation phase, the temporary file is compiled. Depending upon the status of line
number tracking, error messages encountered in this phase will be printed with the file name and
22-3
GAUSS User Guide
line numbers corresponding to both the main file and the temporary file.
22.3.3
Execution Phase
In the execution phase, the compiled program is executed. Depending on the status of line number
tracking, error messages will include line number references from both the main file and the
temporary file.
22.4
Reserved Variables
The following local variables are created by the translator and used in the produced code:
x_cv
x_drop
x_fpin
x_fpout
x_i
x_in
x_iptr
x_keep
x_lval
x_lvar
x_n
x_name
x_ncol
x_nlag
x_nrow
x_ntrim
x_out
x_outtyp
x_plag
x_ptrim
x_shft
x_tname
x_vname
x_x
These variables are reserved, and should not be used within a dataloop... endata section.
22-4
The GAUSS Profiler
23
GAUSS now includes a profiler, which enables you to determine exactly how much time your
programs are spending on each line and in each called procedure, thereby providing you with the
information you need to increase the efficiency of your programs.
23.1
Using the GAUSS Profiler
Profiler
There are two steps to using the GAUSS Profiler: collection and analysis.
23.1.1
Collection
To collect profiling information, you must run your GAUSS program in tcollect, an executable
shipped with GAUSS that is identical to tgauss except that it generates a file containing profiling
information each time it is run:
tcollect -b myfile.e
23-1
GAUSS User Guide
The output displayed by tcollect includes the name of the output file containing the profiling
information. tcollect output files have a gaussprof prefix and a .gco extension.
Note that running tcollect on long programs may generate a very large .gco output file. Thus
you may want to delete the .gco files on your machine regularly.
23.1.2
Analysis
To analyze the information stored in the tcollect output file, you must run the gaussprof
executable, which is also shipped with GAUSS, on that file. gaussprof produces an organized
report, displaying the time usage by procedure and by line.
Assuming that running myfile.e in tcollect produced an output file called
gaussprof_001.gco, you could analyze the results in that file as follows:
gaussprof gaussprof_001.gco
The syntax for gaussprof is:
gaussprof [flags] profile data file ...
where [flags] may be any of the following:
-p
profile procedure calls
-l
profile line numbers
-h
suppress headers
-sp order
procedure call sort order where order contains one or more of the folllowing:
23-2
e
exclusive time
t
total time
The GAUSS Profiler
c
number of times called
p
procedure name
a
ascending order
d
descending order (default)
Columns are sorted all ascending or all descending.
-sl order
line number sort order where order contains one or more of the folllowing:
t
time spent on line
c
number of times line was executed
f
file name
l
line number
a
ascending order
d
descending order (default)
Columns are sorted all ascending or all descending.
The default, with no flags, is: -pl -sp dep -sl dtf.
Profiler
23-3
Publication Quality Graphics
24
GAUSS Publication Quality Graphics (PQG) is a set of routines built on the graphics functions
in GraphiC by Scientific Endeavors Corporation.
The main graphics routines include xy, xyz, surface, polar and log plots, as well as histograms,
bar, and box graphs. Users can enhance their graphs by adding legends, changing fonts, and
adding extra lines, arrows, symbols and messages.
The user can create a single full size graph, inset a smaller graph into a larger one, tile a window
with several equally sized graphs or place several overlapping graphs in the window. Graphic
panel size and location are all completely under the user’s control.
General Design
PQG
24.1
GAUSS PQG consists of a set of main graphing procedures and several additional procedures and
global variables for customizing the output.
All of the actual output to the window happens during the call to these main routines:
24-1
GAUSS User Guide
bar
Bar graphs.
box
Box plots.
contour
Contour plots.
draw
Draw graphs using only global variables.
hist
Histogram.
histp
Percentage histogram.
histf
Histogram from a vector of frequencies.
loglog
Log scaling on both axes.
logx
Log scaling on X axis.
logy
Log scaling on Y axis.
polar
Polar plots.
surface
3-D surface with hidden line removal.
xy
Cartesian graph.
xyz
3-D Cartesian graph.
24.2
24.2.1
Using Publication Quality Graphics
Getting Started
There are four basic parts to a graphics program. These elements should be in any program that
uses graphics routines. The four parts are the header, data setup, graphics format setup, and
graphics call.
24-2
Publication Quality Graphics
Header
In order to use the graphics procedures, the pgraph library must be activated. This is done in the
library statement at the top of your program or command file. The next line in your program will
typically be a command to reset the graphics global variables to their default state. For example:
library mylib, pgraph;
graphset;
Data Setup
The data to be graphed must be in matrices. For example:
x = seqa(1,1,50);
y = sin(x);
Graphics Format Setup
Most of the graphics elements contain defaults that allow the user to generate a plot without
modification. These defaults, however, may be overridden by the user through the use of global
variables and graphics procedures. Some of the elements that may be configured by the user are
axes numbering, labeling, cropping, scaling, line and symbol sizes and types, legends, and colors.
Calling Graphics Routines
PQG
The graphics routines take as input the user data and global variables that have previously been
set. It is in these routines where the graphics file is created and displayed.
Following are three PQG examples. The first two programs are different versions of the same
graph. The variables that begin with _p are the global control variables used by the graphics
24-3
GAUSS User Guide
routines. (For a detailed description of these variables, see G C V, Section
24.6.
Example 1 The routine being called here is a simple XY plot. The entire window will be used.
Four sets of data will be plotted with the line and symbol attributes automatically selected. This
graph will include a legend, title, and a time/date stamp (time stamp is on by default):
library pgraph;
graphset;
x = seqa(.1,.1,100);
y = sin(x);
y = y ˜ y*.8 ˜ y*.6 ˜ y*.4;
_plegctl = 1;
title("Example xy Graph");
xy(x,y);
/* activate PGRAPH library */
/* reset global variables */
/* generate data */
/*
/*
/*
/*
4 curves plotted against x */
legend on */
Main title */
Call to main routine */
Example 2 Here is the same graph with more of the graphics format controlled by the user. The
first two data sets will be plotted using symbols at data points only (observed data); the data points
in the second two sets will be connected with lines (predicted results):
library pgraph;
graphset;
x = seqa(.1,.1,100);
y = sin(x);
y = y ˜ y*.8 ˜ y*.6 ˜ y*.4;
_pdate = "";
_plctrl = { 1, 1, 0, 0 };
_pltype = { 1, 2, 6, 6 };
_pstype = { 1, 2, 0, 0 };
_plegctl= { 2, 3, 1.7, 4.5 };
_plegstr= "Sin wave 1.\0"\
"Sin wave .8\0"\
"Sin wave .6\0"\
"Sin wave .4";
ylabel("Amplitude");
24-4
/* activate PGRAPH library */
/* reset global variables */
/* generate data */
/*
/*
/*
/*
/*
/*
/*
4 curves plotted against x */
date is not printed */
2 curves w/symbols, 2 without */
dashed, dotted, solid lines */
symbol types circles, squares */
legend size and locations */
4 lines legend text */
/* Y axis label */
Publication Quality Graphics
xlabel("X Axis");
title("Example xy Graph");
xy(x,y);
/* X axis label */
/* main title */
/* call to main routine */
Example 3 In this example, two graphics panels are drawn. The first is a full-sized surface
representation, and the second is a half-sized inset containing a contour of the same data located in
the lower left corner of the window:
library pgraph;
/* activate pgraph library */
/* Generate data for surface and contour plots */
x = seqa(-10,0.1,71)’;
/* note x is a row vector */
y = seqa(-10,0.1,71);
/* note y is a column vector */
z = cos(5*sin(x) - y);
/* z is a 71x71 matrix */
begwind;
makewind(9,6.855,0,0,0);
makewind(9/2,6.855/2,1,1,0);
/* initialize graphics windows */
/* first window full size */
/* second window inset to first */
setwind(1);
graphset;
_pzclr = { 1, 2, 3, 4 };
title("cos(5*sin(x) - y)");
xlabel("X Axis");
ylabel("Y Axis");
scale3d(miss(0,0),miss(0,0),-5|5);
surface(x,y,z);
/*
/*
/*
/*
/*
/*
/*
/*
activate first window */
reset global variables */
set Z level colors */
set main title */
set X axis label */
set Y axis label */
scale Z axis */
call surface routine */
/*
/*
/*
/*
/*
activate second window. */
reset global variables */
set Z level colors */
white border */
call contour routine */
endwind;
/* Display windows */
PQG
nextwind;
graphset;
_pzclr = { 1, 2, 3, 4 };
_pbox = 15;
contour(x,y,z);
24-5
GAUSS User Guide
While the structure has changed somewhat, the four basic elements of the graphics program are all
here. The additional routines begwind, endwind, makewind, nextwind, and setwind are all
used to control the graphic panels.
As Example 3 illustrates, the code between graphic panel functions (that is, setwind or
nextwind) may include assignments to global variables, a call to graphset, or may set up new
data to be passed to the main graphics routines.
You are encouraged to run the example programs supplied with GAUSS. Analyzing these
programs is perhaps the best way to learn how to use the PQG system. The example programs are
located on the examples subdirectory.
24.2.2
Graphics Coordinate System
PQG uses a 4190×3120 pixel resolution grid on a 9.0×6.855-inch printable area. There are three
units of measure supported with most of the graphics global elements:
Inch Coordinates
Inch coordinates are based on the dimensions of the full-size 9.0×6.855-inch output page. The
origin is (0,0) at the lower left corner of the page. If the picture is rotated, the origin is at the upper
left. (For more information, see I U  G P, Section 24.3.5.)
Plot Coordinates
Plot coordinates refer to the coordinate system of the graph in the units of the user’s X, Y and Z
axes.
Pixel Coordinates
Pixel coordinates refer to the 4096×3120 pixel coordinates of the full-size output page. The origin
is (0,0) at the lower left corner of the page. If the picture is rotated, the origin is at the upper left.
24-6
Publication Quality Graphics
24.3
Graphic Panels
Multiple graphic panels for graphics are supported. These graphic panels allow the user to display
multiple graphs on one window or page.
A graphic panel is any rectangular subsection of the window or page. Graphc panels may be any
size and position on the window and may be tiled or overlapping, transparent or nontransparent.
24.3.1
Tiled Graphic Panels
Tiled graphic panels do not overlap. The window can easily be divided into any number of tiled
graphic panels with the window command. window takes three parameters: number of rows,
number of columns, and graphic panel attribute (1=transparent, 0=nontransparent).
This example will divide the window into six equally sized graphic panels. There will be two rows
of three graphic panels–three graphic panels in the upper half of the window and three in the lower
half. The attribute value of 0 is arbitrary since there are no other graphic panels beneath them.
window(nrows,ncols,attr);
window(2,3,0);
24.3.2
Overlapping Graphic Panels
Overlapping graphic panels are laid on top of one another as they are created, much as if you were
using the cut and paste method to place several graphs together on one page. An overlapping
graphic panel is created with the makewind command.
makewind(hsize,vsize,hpos,vpos,attr);
24-7
PQG
In this example, makewind will create an overlapping graphic panel that is 4 inches wide by 2.5
inches tall, positioned 1 inch from the left edge of the page and 1.5 inches from the bottom of the
page. It will be nontransparent:
GAUSS User Guide
window(2,3,0);
makewind(4,2.5,1,1.5,0);
24.3.3
Nontransparent Graphic Panels
A nontransparent graphic panel is one that is blanked before graphics information is written to it.
Therefore, information in any previously drawn graphic panels that lie under it will not be visible.
24.3.4
Transparent Graphic Panels
A transparent graphic panel is one that is not blanked, allowing the graphic panel beneath it to
“show through”. Lines, symbols, arrows, error bars, and other graphics objects may extend from
one graphic panel to the next by using transparent graphic panels. First, create the desired graphic
panel configuration. Then create a full-window, transparent graphic panel using the makewind or
window command. Set the appropriate global variables to position the desired object on the
transparent graphic panel. Use the draw procedure to draw it. This graphic panel will act as a
transparent “overlay” on top of the other graphic panels. Transparent graphic panels can be used to
add text or to superimpose one graphic panel on top of another.
24.3.5
Using Graphic Panel Functions
The following is a summary of the graphic panel functions:
begwind
Graphic panel initialization procedure.
endwind
End graphic panel manipulations, display graphs.
window
Partition window into tiled graphic panels.
makewind
Create graphic panel with specified size and position.
setwind
Set to specified graphic panel number.
24-8
Publication Quality Graphics
nextwind
Set to next available graphic panel number.
getwind
Get current graphic panel number.
savewind
Save graphic panel configuration to a file.
loadwind
Load graphic panel configuration from a file.
This example creates four tiled graphic panels and one graphic panel that overlaps the other four:
library pgraph;
graphset;
begwind;
window(2,2,0);
/* Create four tiled graphic panels
(2 rows, 2 columns) */
xsize = 9/2;
/* Create graphic panel that overlaps the
tiled graphic panels */
ysize = 6.855/2;
makewind(xsize,ysize,xsize/2,ysize/2,0);
x = seqa(1,1,1000);
y = (sin(x) + 1) * 10.;
/* Graph #1, upper left corner */
/* Graph #2, upper right corner */
/* Graph #3, lower left corner */
PQG
setwind(1);
xy(x,y);
nextwind;
logx(x,y);
nextwind;
logy(x,y);
nextwind;
loglog(x,y);
nextwind;
bar(x,y);
endwind;
/* Create X data */
/* Create Y data */
/* Graph #4, lower right corner */
/* Graph #5, center, overlayed */
/* End graphic panel processing,
display graph */
24-9
GAUSS User Guide
24.3.6
Inch Units in Graphic Panels
Some global variables allow coordinates to be input in inches. If a coordinate value is in inches
and is being used in a graphic panel, that value will be scaled to “graphic panel inches” and
positioned relative to the lower left corner of the graphic panel. A “graphic panel inch” is a true
inch in size only if the graphic panel is scaled to the full window, otherwise X coordinates will be
scaled relative to the horizontal graphic panel size and Y coordinates will be scaled relative to the
vertical graphic panel size.
24.3.7
Saving Graphic Panel Configurations
The functions savewind and loadwind allow the user to save graphic panel configurations. Once
graphic panels are created (using makewind and window), savewind may be called. This will
save to disk the global variables containing information about the current graphic panel
configuration. To load this configuration again, call loadwind. (See loadwind in the GAUSS
L R.
24.4
Graphics Text Elements
Graphics text elements, such as titles, messages, axes labels, axes numbering, and legends, can be
modified and enhanced by changing fonts and by adding superscripting, subscripting, and special
mathematical symbols.
To make these modifications and enhancements, the user can embed “escape codes” in the text
strings that are passed to title, xlabel, ylabel and asclabel or assigned to _pmsgstr and
_plegstr.
The escape codes used for graphics text are:
\000
[
]
@
\20n
24-10
String termination character (null byte).
Enter superscript mode, leave subscript mode.
Enter subscript mode, leave superscript mode.
Interpret next character as literal.
Select font number n. (see S F, following).
Publication Quality Graphics
The escape code \L (or \l) can be embedded into title strings to create a multiple line title:
title("This is the first line\lthis is the second line");
A null byte \000 is used to separate strings in _plegstr and _pmsgstr:
_pmsgstr = "First string\000Second string\000Third string";
or
_plegstr = "Curve 1\000Curve 2";
Use [..] to create the expression M(t) = E(etx ):
_pmsgstr = "M(t) = E(e[tx])";
Use @ to generate [ and ] in an X axis label:
xlabel("Data used for x is: data@[.,1 2 3@]");
24.4.1
Selecting Fonts
Fonts are loaded by passing to the fonts procedure a string containing the names of all fonts to be
loaded. For example, this statement will load all four fonts:
24-11
PQG
Four fonts are supplied with the Publication Quality Graphics system. They are Simplex,
Complex, Simgrma, and Microb. (For a list of the characters available in each font, see Appendix
A.)
GAUSS User Guide
fonts("simplex complex microb simgrma");
The fonts command must be called before any of the fonts can be used in text strings. A font can
then be selected by embedding an escape code of the form “\20n” in the string that is to be written
in the new font. The n will be 1, 2, 3 or 4, depending on the order in which the fonts were loaded
in fonts. If the fonts were loaded as in the previous example, the escape characters for each
would be:
\201
\202
\203
\204
Simplex
Complex
Microb
Simgrma
The following example demonstrates how to select a font for use in a string:
title("\201This is the title using Simplex font");
xlabel("\202This is the label for X using Complex font");
ylabel("\203This is the label for Y using Microb font");
Once a font is selected, all succeeding text will use that font until another font is selected. If no
fonts are selected by the user, a default font (Simplex) is loaded and selected automatically for all
text work.
24.4.2
Greek and Mathematical Symbols
The following examples illustrate the use of the Simgrma font; they assume that Simgrma was the
fourth font loaded. (For the available Simgrma characters and their numbers, see Appendix A.)
The Simgrma characters are specified by either:
1. The character number, preceeded by a “\”.
2. The regular text character with the same number.
24-12
Publication Quality Graphics
R
For example, to get an integral sign “ ” in Simgrma, embed either a “\044” or a “,” in a string
that has been set to use the Simgrma font.
To produce the title f (x) = sin2 (πx), the following title string should be used:
title("\201f(x) = sin[2](\204p\201x)");
The “p” (character 112) corresponds to “π” in Simgrma.
To number the major X axis tick marks with multiples of π/4, the following could be passed to
asclabel:
lab = "\2010 \204p\201/4 \204p\201/2
asclabel(lab,0);
xtics(0,pi,pi/4,1);
3\204p\201/4 \204p";
xtics is used to make sure that major tick marks are placed in the appropriate places.
This example will number the X axis tick marks with the labels µ−2 , µ−1 , 1, µ, and µ2 :
lab = "\204m\201[-2] \204m\201[-1] 1 \204m m\201[2]";
asclabel(lab,0);
This example illustrates the use of several of the special Simgrma symbols:
_pmsgstr =
"\2041\2011/2\204p ,\201e[-\204m[\2012]\201/2]d\204m";
PQG
This produces:
√
1/2π
Z
e−µ /2 dµ
2
24-13
GAUSS User Guide
24.5
Colors
0
1
2
3
4
5
6
7
24.6
Black
Blue
Green
Cyan
Red
Magenta
Brown
Grey
8
9
10
11
12
13
14
15
Dark Grey
Light Blue
Light Green
Light Cyan
Light Red
Light Magenta
Yellow
White
Global Control Variables
The following global variables are used to control various graphics elements. Default values are
provided. Any or all of these variables can be set before calling one of the main graphing routines.
The default values can be modified by changing the declarations in pgraph.dec and the
statements in the procedure graphset in pgraph.src. graphset can be called whenever the
user wants to reset these variables to their default values.
_pageshf
2×1 vector, the graph will be shifted to the right and up if this is not 0. If this is
0, the graph will be centered on the output page. Default is 0.
Note: Used internally. (For the same functionality, see makewind in the
GAUSS L R.) This is used by the graphic panel routines. The
user must not set this when using the graphic panel procedures.
_pagesiz
2×1 vector, size of the graph in inches on the printer output. Maximum size is
9.0×6.855 inches (unrotated) or 6.855×9.0 inches (rotated). If this is 0, the
maximum size will be used. Default is 0.
Note: Used internally. (For the same functionality, see makewind in the
GAUSS L R). This is used by the graphic panel routines. The
user must not set this when using the graphic panel procedures.
_parrow
24-14
M×11 matrix, draws one arrow per row of the input matrix (for total of M
arrows). If scalar zero, no arrows will be drawn.
Publication Quality Graphics
[M,1] x starting point.
[M,2] y starting point.
[M,3] x ending point.
[M,4] y ending point.
[M,5] ratio of the length of the arrow head to half its width.
[M,6] size of arrow head in inches.
[M,7] type and location of arrow heads. This integer number will be
interpreted as a decimal expansion mn, for example: if 10, then m = 1, n =
0.
m, type of arrow head:
0
1
2
3
solid
empty
open
closed
n, location of arrow head:
0
1
2
none
at the final end
at both ends
[M,8] color of arrow, see C, Section 24.5.
[M,9] coordinate units for location:
1
2
3
x,y starting and ending locations in plot coordinates
x,y starting and ending locations in inches
x,y starting and ending locations in pixels
[M,10] line type:
dashed
dotted
short dashes
closely spaced dots
dots and dashes
solid
PQG
1
2
3
4
5
6
24-15
GAUSS User Guide
[M,11] controls thickness of lines used to draw arrow. This value may be zero
or greater. A value of zero is normal line width.
To create two single-headed arrows, located using inches, use
_parrow = {
_parrow3
1
3
1
4
2
2
2
2
3
3
0.2
0.2
11
11
10
10
2
2
6
6
0,
0 };
M×12 matrix, draws one 3-D arrow per row of the input matrix (for a total of M
arrows). If scalar zero, no arrows will be drawn.
[M,1] x starting point in 3-D plot coordinates.
[M,2] y starting point in 3-D plot coordinates.
[M,3] z starting point in 3-D plot coordinates.
[M,4] x ending point in 3-D plot coordinates.
[M,5] y ending point in 3-D plot coordinates.
[M,6] z ending point in 3-D plot coordinates.
[M,7] ratio of the length of the arrow head to half its width.
[M,8] size of arrow head in inches.
[M,9] type and location of arrow heads. This integer number will be
interpreted as a decimal expansion mn. For example: if 10, then m = 1, n
= 0.
m, type of arrow head:
0
1
2
3
solid
empty
open
closed
n, location of arrow head:
0
1
2
none
at the final end
at both ends
[M,10] color of arrow, see C, Section 24.5.
24-16
Publication Quality Graphics
[M,11] line type:
1
2
3
4
5
6
dashed
dotted
short dashes
closely spaced dots
dots and dashes
solid
[M,12] controls thickness of lines used to draw arrow. This value may be zero
or greater. A value of zero is normal line width.
To create two single-headed arrows, located using plot coordinates, use
_parrow3 = {
_paxes
1
3
1
4
1
5
2
2
2
2
2
2
3
3
0.2
0.2
11
11
10
10
6
6
0,
0 };
scalar, 2×1, or 3×1 vector for independent control for each axis. The first
element controls the X axis, the second controls the Y axis, and the third (if set)
controls the Z axis. If 0 the axis will not be drawn. Default is 1.
If this is a scalar, it will be expanded to that value.
For example:
_paxes = { 1, 0 }; /* turn X axis on, Y axis off */
_paxes = 0;
/* turn all axes off */
_paxes = 1;
/* turn all axes on */
scalar, size of axes labels in inches. If 0, a default size will be computed.
Default is 0.
_pbartyp
1×2 or K×2 matrix. Controls bar shading and colors in bar graphs and
histograms.
PQG
_paxht
The first column controls the bar shading:
0
no shading
1
dots
24-17
GAUSS User Guide
2
vertical cross-hatch
3
diagonal lines with positive slope
4
diagonal lines with negative slope
5
diagonal cross-hatch
6
solid
The second column controls the bar color, see C, Section 24.5.
_pbarwid
scalar, width of bars in bar graphs and histograms. The valid range is 0-1. If 0,
the bars will be a single pixel wide. If 1, the bars will touch each other. Default
is 0.5, so the bars take up about half the space open to them.
_pbox
scalar, draws a box (border) around the entire graph. Set to desired color of box
to be drawn. Use 0 if no box is desired. Default is 0.
_pboxctl
5×1 vector, controls box plot style, width, and color. Used by procedure box
only.
[1]
box width between 0 and 1. If 0, the box plot is drawn as two vertical
lines representing the quartile ranges with a filled circle representing the
50th percentile.
[2]
box color, see C, Section 24.5. If 0, the colors may be individually
controlled using global variable _pcolor.
[3]
min/max style for the box symbol. One of the following:
1
2
3
24-18
minimum and maximum taken from the actual limits of the data.
Elements 4 and 5 are ignored.
statistical standard with the minimum and maximum calculated
according to interquartile range as follows:
intqrange = 75th − 25th
min
= 25th − 1.5 intqrange
max
= 75th + 1.5 intqrange
Elements 4 and 5 are ignored.
minimum and maximum percentiles taken from elements 4 and 5.
[4]
minimum percentile value (0-100) if _pboxctl[3] = 3.
[5]
maximum percentile value (0-100) if _pboxctl[3] = 3.
Publication Quality Graphics
_pboxlim
5×M output matrix containing computed percentile results from procedure box.
M corresponds to each column of input y data.
[1,M] minimum whisker limit according to _pboxctl[3].
[2,M] 25th percentile (bottom of box).
[3,M] 50th percentile (median).
[4,M] 75th percentile (top of box).
[5,M] maximum whisker limit according to _pboxctl[3].
_pcolor
scalar or K×1 vector, colors for main curves in xy, xyz and log graphs. To use
a single color set for all curves set this to a scalar color value. If 0, use default
colors. Default is 0.
The default colors come from a global vector called _pcsel. This vector can be
changed by editing pgraph.dec to change the default colors, see C,
Section 24.5 (_pcsel is not documented elsewhere).
_pcrop
scalar or 1×5 vector, allows plot cropping for different graphic elements to be
individually controlled. Valid values are 0 (disabled) or 1 (enabled). If cropping
is enabled, any graphical data sent outside the axes area will not be drawn. If
this is a scalar, it is expanded to a 1×5 vector using the given value for all
elements. All cropping is enabled by default.
[1]
crop main curves/symbols.
[2]
crop lines generated using _pline.
[3]
crop arrows generated using _parrow.
[4]
crop circles/arcs generated using _pline.
[5]
crop symbols generated using _psym.
_pcrop = { 1 1 0 1 0 };
_pcross
scalar. If 1, the axes will intersect at the (0,0) X-Y location if it is visible.
Default is 0, meaning the axes will be at the lowest end of the X-Y coordinates.
24-19
PQG
This example will crop main curves, and lines and circles drawn by _pline.
GAUSS User Guide
_pdate
date string. If this contains characters, the date will be appended and printed.
The default is set as follows (the first character is a font selection escape code):
_pdate = "\201GAUSS
";
If this is set to a null string, no date will be printed. (For more information on
using fonts within strings, see G T E, Section 24.4.
_perrbar
M×9 matrix, draws one error bar per row of the input matrix. If scalar 0, no
error bars will be drawn. Location values are in plot coordinates.
[M,1] x location.
[M,2] left end of error bar.
[M,3] right end of error bar.
[M,4] y location.
[M,5] bottom of error bar.
[M,6] top of error bar.
[M,7] line type:
1
2
3
4
5
6
dashed
dotted
short dashes
closely spaced dots
dots and dashes
solid
[M,8] color, see C, Section 24.5.
[M,9] line thickness.. This value may be 0 or greater. A value of 0 is normal
line width.
To create one error bar using solid lines, use
_perrbar = { 1
_pframe
24-20
0
2
2
1
3
6
2
0 };
2×1 vector, controls frame around axes area. On 3-D plots this is a cube
surrounding the 3-D workspace.
Publication Quality Graphics
[1]
1
0
frame on
frame off
[2]
1
0
tick marks on frame
no tick marks
The default is a frame with tick marks.
_pgrid
2×1 vector to control grid.
[1]
grid through tick marks:
0
1
2
3
[2]
no grid
dotted grid
fine dotted grid
solid grid
grid subdivisions between major tick marks:
0
1
2
no subdivisions
dotted lines at subdivisions
tick marks only at subdivisions
The default is no grid and tick marks at subdivisions.
_plctrl
scalar or K×1 vector to control whether lines and/or symbols will be displayed
for the main curves. This also controls the frequency of symbols on main
curves. The number of rows (K) is equal to the number of individual curves to
be plotted in the graph. Default is 0.
0
draw line only.
draw line and symbols every _plctrl points.
<0
draw symbols only every _plctrl points.
−1
all of the data points will be plotted with no connecting lines.
This example draws a line for the first curve, draws a line and plots a symbol
every 10 data points for the second curve, and plots symbols only every 5 data
points for the third curve:
_plctrl = { 0, 10, -5 };
24-21
PQG
>0
GAUSS User Guide
_plegctl
scalar or 1×4 vector, legend control variable.
If scalar 0, no legend is drawn (default). If nonzero scalar, create legend in the
default location in the lower right of the page.
If 1×4 vector, set as follows:
[1]
legend position coordinate units:
1
2
3
coordinates are in plot coordinates
coordinates are in inches
coordinates are in pixel
[2]
legend text font size, where 1 <= size <= 9. Default is 5.
[3]
x coordinate of lower left corner of legend box.
[4]
y coordinate of lower left corner of legend box.
This example puts a legend in the lower right corner:
_plegctl = 1;
This example creates a smaller legend and positions it 2.5 inches from the left
and 1 inch from the bottom.
_plegctl = { 2 3 2.5 1 };
_plegstr
string, legend entry text. Text for multiple curves is separated by a null byte
(“\000”).
For example:
_plegstr = "Curve 1\000Curve 2\000Curve 3";
_plev
M×1 vector, user-defined contour levels for contour. Default is 0. (See
contour in the GAUSS L R.)
_pline
M×9 matrix, to draw lines, circles, or radii. Each row controls one item to be
drawn. If this is a scalar zero, nothing will be drawn. Default is 0.
[M,1] item type and coordinate system:
24-22
Publication Quality Graphics
1
2
3
4
5
6
7
line in plot coordinates
line in inch coordinates
line in pixel coordinates
circle in plot coordinates
circle in inch coordinates
radius in plot coordinates
radius in inch coordinates
[M,2] line type:
1
2
3
4
5
6
dashed
dotted
short dashes
closely spaced dots
dots and dashes
solid
[M,3-7] coordinates and dimensions:
if item type is line (1<=_pline[M,1]<=3):
[M,3]
[M,4]
[M,5]
[M,6]
[M,7]
x starting point.
y starting point.
x ending point.
y ending point.
0 if this is a continuation of a curve, 1 if this begins a new curve.
if item type is circle (_pline[M,1] = 4 or _pline[M,1] = 5):
x center of circle.
y center of circle.
radius.
starting point of arc in radians.
ending point of arc in radians.
PQG
[M,3]
[M,4]
[M,5]
[M,6]
[M,7]
if item type is radius (_pline[M,1] = 6 or _pline[M,1] = 7):
[M,3] x center of circle.
[M,4] y center of circle.
[M,5] beginning point of radius, 0 is the center of the circle.
24-23
GAUSS User Guide
[M,6] ending point of radius.
[M,7] angle in radians.
[M,8] color, see C, Section 24.5.
[M,9] controls line thickness. This value may be zero or greater. A value of
zero is normal line width.
_pline3d
M×9 matrix. Allows extra lines to be added to an xyz or surface graph in 3-D
plot coordinates.
[M,1] x starting point.
[M,2] y starting point.
[M,3] z starting point.
[M,4] x ending point.
[M,5] y ending point.
[M,6] z ending point.
[M,7] color.
[M,8] line type:
1
2
3
4
5
6
dashed
dotted
short dashes
closely spaced dots
dots and dashes
solid
[M,9] line thickness, 0 = normal width.
[M,10] hidden line flag, 1 = obscured by surface, 0 = not obscured.
_plotshf
2×1 vector, distance of plot from lower left corner of output page in inches.
[1]
x distance.
[2]
y distance.
If scalar 0, there will be no shift. Default is 0.
Note: Used internally. (For the same functionality, see axmargin in the
GAUSS L R.) This is used by the graphic panel routines. The
user must not set this when using the graphic panel procedures.
24-24
Publication Quality Graphics
_plotsiz
2×1 vector, size of the axes area in inches. If scalar 0, the maximum size will
be used.
Note: Used internally. (For the same functionality, see axmargin in the
GAUSS L R.) This is used by the graphic panel routines. The
user must not set this when using the graphic panel procedures.
_pltype
scalar or K×1 vector, line type for the main curves. If this is a nonzero scalar, all
lines will be this type. If scalar 0, line types will be default styles. Default is 0.
1
dashed
2
dotted
3
short dashes
4
closely spaced dots
5
dots and dashes
6
solid
The default line types come from a global vector called _plsel. This vector
can be changed by editing pgraph.dec to change the default line types
(_plsel is not documented elsewhere.)
_plwidth
scalar or K×1 vector, line thickness for main curves. This value may be zero or
greater. A value of zero is normal (single pixel) line width. Default is 0.
_pmcolor
9×1 vector, color values to use for plot, see C, Section 24.5.
axes.
[2]
axes numbers.
[3]
X axis label.
[4]
Y axis label.
[5]
Z axis label.
[6]
title.
[7]
box.
[8]
date.
[9]
background.
PQG
[1]
24-25
GAUSS User Guide
If this is scalar, it will be expanded to a 9×1 vector.
_pmsgctl
L×7 matrix of control information for printing the strings contained in
_pmsgstr.
[L,1] horizontal location of lower left corner of string.
[L,2] vertical location of lower left corner of string.
[L,3] character height in inches.
[L,4] angle in degrees to print string. This may be -180 to 180 relative to the
positive X axis.
[L,5] location coordinate system.
1
2
location of string in plot coordinates
location of string in inches
[L,6] color.
[L,7] font thickness, may be 0 or greater. If 0 use normal line width.
_pmsgstr
string, contains a set of messages to be printed on the plot. Each message is
separated from the next by a null byte (\000). The number of messages must
correspond to the number of rows in the _pmsgctl control matrix. This can be
created as follows:
_pmsgstr = "Message one.\000Message two.";
_pnotify
_pnum
scalar, controls window output during the creation of the graph. Default is 1.
0
no activity to the window while writing .tkf file
1
display progress as fonts are loaded, and .tkf file is being generated
scalar, 2×1 or 3×1 vector for independent control for axes numbering. The first
element controls the X axis numbers, the second controls the Y axis numbers,
and the third (if set) controls the Z axis numbers. Default is 1.
If this value is scalar, it will be expanded to a vector.
24-26
0
no axes numbers displayed
1
axes numbers displayed, vertically oriented on axis
Publication Quality Graphics
2
axes numbers displayed, horizontally oriented on axis
For example:
_pnum = { 0, 2 }; /* no X axis numbers, */
/* horizontal on Y axis */
_pnumht
scalar, size of axes numbers in inches. If 0, a size of .13 will be used. Default is
0.
_protate
scalar. If 0, no rotation, if 1, plot will be rotated 90 degrees. Default is 0.
_pscreen
scalar. If 1, display graph in window, if 0, do not display graph in window.
Default is 1.
_psilent
scalar. If 0, a beep will sound when the graph is finished drawing to the
window. Default is 1 (no beep).
_pstype
scalar or K×1 vector, controls symbol used at data points. To use a single
symbol type for all points, set this to one of the following scalar values:
1
2
3
4
5
6
7
circle
square
triangle
plus
diamond
inverted triangle
star
8
9
10
11
12
13
14
solid circle
solid square
solid triangle
solid plus
solid diamond
solid inverted triangle
solid star
If this is a vector, each line will have a different symbol. Symbols will repeat if
there are more lines than symbol types. Default is 0 (no symbols are shown).
PQG
_psurf
2×1 vector, controls 3-D surface characteristics.
[1]
if 1, show hidden lines. Default is 0.
[2]
color for base, see C, Section 24.5. The base is an outline of the X-Y
plane with a line connecting each corner to the surface. If 0, no base is
drawn. Default is 7.
24-27
GAUSS User Guide
_psym
M×7 matrix, M extra symbols will be plotted.
[M,1] x location.
[M,2] y location.
[M,3] symbol type, see _pstype earlier.
[M,4] symbol height. If this is 0, a default height of 5.0 will be used.
[M,5] symbol color, see C, Section 24.5.
[M,6] type of coordinates:
1
2
plot coordinates
inch coordinates
[M,7] line thickness. A value of zero is normal line width.
_psym3d
M×7 matrix for plotting extra symbols on a 3-D (surface or xyz) graph.
[M,1] x location in plot coordinates.
[M,2] y location in plot coordinates.
[M,3] z location in plot coordinates.
[M,4] symbol type, see _pstype earlier.
[M,5] symbol height. If this is 0, a default height of 5.0 will be used.
[M,6] symbol color, see C, Section 24.5.
[M,7] line thickness. A value of 0 is normal line width.
Use _psym for plotting extra symbols in inch coordinates.
_psymsiz
scalar or K×1 vector, symbol size for the symbols on the main curves. This is
NOT related to _psym. If 0, a default size of 5.0 is used.
_ptek
string, name of Tektronix format graphics file. This must have a .tkf
extension. If this is set to a null string, the graphics file will be suppressed. The
default is graphic.tkf.
_pticout
scalar. If 1, tick marks point outward on graphs. Default is 0.
_ptitlht
scalar, the height of the title characters in inches. If this is 0, a default height of
approx. 0.13 inch will be used.
24-28
Publication Quality Graphics
_pversno
string, the graphics version number.
_pxpmax
scalar, the maximum number of places to the right of the decimal point for the
X axis numbers. Default is 12.
_pxsci
scalar, the threshold in digits above which the data for the X axis will be scaled
and a power of 10 scaling factor displayed. Default is 4.
_pypmax
scalar, the maximum number of places to the right of the decimal point for the
Y axis numbers. Default is 12.
_pysci
scalar, the threshold in digits above which the data for the Y axis will be scaled
and a power of 10 scaling factor displayed. Default is 4.
_pzclr
scalar, row vector, or K×2 matrix, Z level color control for procedures surface
and contour. (See surface in the GAUSS L R.)
_pzoom
1×3 row vector, magnifies the graphics display for zooming in on detailed areas
of the graph. If scalar 0, no magnification is performed. Default is 0.
[1]
magnification value. 1 is normal size.
[2]
horizontal center of zoomed plot (0-100).
[3]
vertical center of zoomed plot (0-100).
To see the upper left quarter of the screen magnified 2 times use:
_pzoom = { 2 25 75 };
scalar, the maximum number of places to the right of the decimal point for the
Z axis numbers. Default is 3.
_pzsci
scalar, the threshold in digits above which the data for the Z axis will be scaled
and a power of 10 scaling factor displayed. Default is 4.
24-29
PQG
_pzpmax
Time and Date
Time and Date
25
GAUSS offers a comprehensive set of time and date functions. These functions afford the user the
ability to return the current time and date, to carry out most related calculations and format the
results for output. GAUSS also allows the user to perform timed iterations.
In the year 1 AD the calendar in general use was the Julian calendar. The Gregorian calendar that
we use today was not invented until the late 1500’s. This new calendar changed the method of
calculating leap years on century marks. With the Julian system simply every fourth year was a
leap year. The Gregorian system made every fourth year a leap year with the exception of century
marks which are only leap years if divisible by 400. The British adoption of this calendar, which
the GAUSS date functions are based on, did not happen until the year 1752. In that year eleven
days were removed; September 2, 1752 was followed by September 14, 1752.
dtvnormal and utctodtv are accurate back to 1 AD. The rest of the GAUSS date functions
assume a normal Gregorian system regardless of year. Thus, they will not account for the days
taken out in September of 1752, nor will they account for all century marks being leap years
before the adoption of the Gregorian system in 1752.
The time is given by your operating system, daylight savings time is not automatically accounted
for by GAUSS in calculations.
25-1
GAUSS User Guide
25.1
Time and Date Formats
The Time and Date formats in GAUSS fall into one of two major categories, matrix/vector and
string. The matrix/vector formats can be used for either calculations or if desired for output. The
string formats are, however, mostly for use as ouput. Some manipulation of strings is possible
with the use of the stof function.
A 4×1 vector is returned by both the date and time functions.
d = date;
d;
1997.00
5.00000
29.0000
56.4700
/*
/*
/*
/*
Year */
Month */
Day */
Hundredths of a second since midnight */
t = time;
t;
10.00
17.00
33.00
13.81
/*
/*
/*
/*
Hours since midnight */
Minutes */
Seconds */
Hundredths of a second */
These vectors can be written to a string of the desired form by passing them through the
corresponding function.
d = { 1997, 5, 29, 56.47 };
datestr(d);
5/29/97
datestrymd(d);
25-2
19970529
t = { 10, 17, 33, 13.81 };
timestr(t);
10:17:33
A list and brief description of these, and other related functions is provided in the table in section
25.2.
Another major matrix/vector format is the dtv, or date and time vector. The dtv vector is a 1×8
vector used with the dtvnormal and utctodtv functions. The format for the dtv vector is:
Year Month Day Hour Min S ec DoW DiY
1955 4
21
4
16
0
4
110
Where:
Year
Month
Day
Hour
Min
Sec
DoW
DiY
Year, four digit integer.
1-12, Month in year.
1-31, Day of month.
0-23, Hours since midnight.
0-59, Minutes.
0-59, Seconds.
0-6, Day of week, 0=Sunday.
0-365, Days since Jan 1 of current year.
dtvnormal normalizes a date. The last two elements are ignored for input, as shown in the
following example. They are set to the correct values on output. The input can be 1×8 or N×8.
dtv = { 1954 3 17 4 16 0 0 0 };
dtv = dtvnormal(dtv);
25-3
Time and Date
Time and Date
GAUSS User Guide
1954 3 17 4 16 0 3 75
dtv[3] = dtv[3] + 400;
print dtv;
1954 3 417 4 16 0 3 75
dtv = dtvnormal(dtv);
print dtv;
1955 4 21 4 16 0 4 110
25.2
Time and Date Functions
Following is a partial listing of the time and date functions available in GAUSS.
25-4
datestr
Formats a Date vector to a string (mo/dy/yr).
datestrymd
Formats a Date vector to an eight character string of the type
yyyymmdd.
dayinyr
Returns day number in the year of a given date.
_daypryr
Returns the number of days in the years given as input.
dtvnormal
Normalizes a 1×8 dtv vector.
etdays
Computes the difference in days between two dates.
ethsec
Computes the difference between two times in hundredths of a
second.
etstr
Formats a time difference measured in hundreths of a second to a
string.
_isleap
Returns a vector of ones and zeros, 1 if leap year 0 if not.
timestr
Formats a Time vector to a string hr:mn:sc.
timeutc
Universal time coordinate, number of seconds since January 1, 1970
Greenwich Mean Time.
utctodtv
Converts a scalar, number of seconds since, or before, Jan 1 1970
Greenwich mean time, to a dtv vector.
Below is an example of two ways to calculate a time difference.
d1 = { 1996, 12, 19, 82 };
d2 = { 1997, 4, 28, 4248879.3 };
dif = ethsec(d1,d2);
ds = etstr(dif);
di f = 1.1274488e + 09
ds = 130days 11hours 48minutes 7.97seconds
If only the number of days is needed use etdays.
d1 = { 1996, 12, 19, 82 };
d2 = { 1997, 4, 28, 4248879.3 };
dif = etdays(d1,d2);
di f = 130.00000
The last element of d1 is optional when used as an input for etdays.
_isleap returns a matrix of ones and zeros, ones when the corresponding year is a leap year.
25-5
Time and Date
Time and Date
GAUSS User Guide
x = seqa(1970,1,20);
y = _isleap(x);
delif(x,abs(y-1));
1972.0000
1976.0000
1980.0000
1984.0000
1988.0000
/* Vector containing all leap years
between 1970 - 1989 */
To calculate the days of a number of consecutive years:
x = seqa(1983,1,3);
y = _daypryr(x);
sumc(y);
1096.0000
To add a portion of the following year:
g = { 1986, 2, 23, 0 };
dy = dayinyr(g);
sumc(y)+dy;
1150.0000
For more information on any of these functions see their respective pages in the command
reference.
25.2.1
Timed Iterations
Iterations of a program can be timed with the use of the hsec function in the following manner.
25-6
et = hsec;
/* Start timer */
/* Segment of code to be timed */
et = (hsec-et)/100;
Time and Date
Time and Date
/* Stop timer, convert to seconds */
A specific example is located in the tutorial section of your supplement.
In the case of a program running from one day into the next you would need to replace the hsec
function with the date function. The ethsec function should be used to compute the time
difference; a straight subtraction as in the previous example will not give the desired result.
dstart = date;
/* Start timer */
/* Segment of code to be timed */
dend = date;
/* Stop timer */
dif = ethsec(dstart,dend)/100;
/* Convert time difference to seconds */
25-7
26
ATOG is a stand-alone conversion utility that converts ASCII files into GAUSS data sets. ATOG
can convert delimited and packed ASCII files into GAUSS data sets. ATOG can be run from a
batch file or the command line.
The syntax is:
atog cmdfile
where cmdfile is the name of the command file. If no extension is given, .cmd will be assumed. If
no command file is specified, a command summary will be displayed.
26.1
Command Summary
The following commands are supported in ATOG:
append
Append data to an existing file.
26-1
ATOG
ATOG
GAUSS User Guide
complex
Treat data as complex variables.
input
The name of the ASCII input file.
invar
Input file variables (column names).
msym
Specify missing value character.
nocheck
Don’t check data type or record length.
output
The name of the GAUSS data set to be created.
outtyp
Output data type.
outvar
List of variables to be included in output file.
preservecase
Preserve case of variable names in output file.
The principle commands for converting an ASCII file that is delimited with spaces or commas are
given in the following example:
input agex.asc;
output agex;
invar $ race # age pay $ sex region;
outvar region age sex pay;
outtyp d;
In this example, a delimited ASCII file agex.asc is converted to a double precision GAUSS data
file agex.dat. The input file has five variables. The file will be interpreted as having five columns:
column
1
2
3
4
5
26-2
name
race
AGE
PAY
sex
region
data type
character
numeric
numeric
character
character
ATOG
The output file will have four columns since the first column of the input file (race) is not included
in the output variables. The columns of the output file are:
name
region
AGE
sex
PAY
data type
character
numeric
character
numeric
ATOG
column
1
2
3
4
The variable names are saved in the file header. Unless preservecase has been specified, the
names of character variables will be saved in lowercase, and the names of numeric variables will
be saved in uppercase. The $ in the invar statement specifies that the variables that follow are
character type. The # specifies numeric. If $ and # are not used in an invar statement, the default
is numeric.
Comments in command files must be enclosed between ‘@’ characters.
26.2
Commands
A detailed explanation of each command follows.
append
Instructs ATOG to append the converted data to an existing data set:
append;
No assumptions are made regarding the format of the existing file. Make certain that the number,
order, and type of data converted match the existing file. ATOG creates v96 format data files, so
will only append to v96 format data files.
26-3
GAUSS User Guide
complex
Instructs ATOG to convert the ASCII file into a complex GAUSS data set:
complex;
Complex GAUSS data sets are stored by rows, with the real and imaginary parts interleaved,
element by element. ATOG assumes the same structure for the ASCII input file, and will thus read
TWO numbers out for EACH variable specified.
complex cannot be used with packed ASCII files.
input
Specifies the file name of the ASCII file to be converted. The full path name can be used in the file
specification.
For example, the command:
input data.raw;
will expect an ASCII data file in the current working directory.
The command:
input /research/data/myfile.asc;
specifies a file to be located in the /research/data subdirectory.
26-4
ATOG
invar
invar age $ name sex # pay var[1:10] x[005];
The invar command above specifies the following variables:
column
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
name
AGE
name
sex
PAY
VAR01
VAR02
VAR03
VAR04
VAR05
VAR06
VAR07
VAR08
VAR09
VAR10
X001
X002
X003
X004
X005
data type
numeric
character
character
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
As the input file is translated, the first 19 elements will be interpreted as the first row (observation),
the next 19 will be interpreted as the second row, and so on. If the number of elements in the file is
not evenly divisible by 19, the final incomplete row will be dropped and a warning message will
be given.
26-5
ATOG
Soft Delimited ASCII Files Soft delimited files may have spaces, commas, or cr/lf as delimiters
between elements. Two or more consecutive delimiters with no data between them are treated as
one delimiter. For example:
GAUSS User Guide
Hard Delimited ASCII Files Hard delimited files have a printable character as a delimiter
between elements. Two delimiters without intervening data between them will be interpreted as a
missing. If \n is specified as a delimiter, the file should have one element per line and blank lines
will be considered missings. Otherwise, delimiters must be printable characters. The dot ‘.’ is
illegal and will always be interpreted as a missing value. To specify the backslash as a delimiter,
use \\. If \r is specified as a delimiter, the file will be assumed to contain one case or record per
line with commas between elements and no comma at the end of the line.
For hard delimited files the delimit subcommand is used with the invar command. The
delimit subcommand has two optional parameters. The first parameter is the delimiter. The
default is a comma. The second parameter is an ‘N’. If the second parameter is present, ATOG
will expect N delimiters. If it is not present, ATOG will expect N-1 delimiters.
This example:
invar delimit(, N) $ name # var[5];
will expect a file like this:
BILL ,
STEVE,
TOM ,
222.3,
624.3,
244.2,
123.2,
340.3,
834.3,
456.4,
,
602.3,
345.2,
624.3,
333.4,
while
invar delimit(,) $ name # var[5];
or
invar delimit $ name # var[5];
will expect a file like this:
26-6
533.2,
639.5,
822.5,
ATOG
BILL ,
STEVE,
TOM ,
222.3,
624.3,
244.2,
123.2,
340.3,
834.3,
456.4,
,
602.3,
345.2,
624.3,
333.4,
533.2,
639.5,
822.5
ATOG
The difference between specifying N or N-1 delimiters can be seen here:
456.4,
,
602.3,
345.2,
624.3,
333.4,
533.2,
639.5,
If the invar statement specified three variables and N-1 delimiters, this file would be interpreted
as having three rows containing a missing in the [2,1] element and the [3,3] element like this:
456.4 345.2 533.2
.
624.3 639.5
602.3 333.4
.
If N delimiters had been specified, this file would be interpreted as having two rows, and a final
incomplete row that is dropped:
456.4 345.2 533.2
.
624.3 639.5
The spaces were shown only for clarity and are not significant in delimited files so:
BILL,222.3,123.2,456.4,345.2,533.2,
STEVE,624.3,340.3,,624.3,639.5,
TOM,244.2,834.3,602.3,333.4,822.5
would work just as well.
Linefeeds are significant only if \n is specified as the delimiter, or when using \r. This example:
26-7
GAUSS User Guide
invar delimit(\r) $ name # var[5];
will expect a file with no comma after the final element in each row:
BILL ,
STEVE,
TOM ,
222.3,
624.3,
244.2,
123.2,
340.3,
834.3,
456.4,
245.3,
602.3,
345.2,
624.3,
333.4,
533.2
639.5
822.5
Packed ASCII Files Packed ASCII files must have fixed length records. The record
subcommand is used to specify the record length, and variables are specified by giving their type,
starting position, length, and the position of an implicit decimal point if necessary.
outvar is not used with packed ASCII files. Instead, invar is used to specify only those variables
to be included in the output file.
For packed ASCII files the syntax of the invar command is as follows:
invar record = reclen (format) variables (format) variables;
where,
reclen
the total record length in bytes, including the final carriage return/line feed if
applicable. Records must be fixed length.
format
(start,length.prec) where:
26-8
start
starting position of the field in the record, 1 is the first position. The default
is 1.
length
the length of the field in bytes. The default is 8.
prec
optional; a decimal point will be inserted automatically prec places in from
the RIGHT edge of the field.
ATOG
If several variables are listed after a format definition, each succeeding field will be assumed to
start immediately after the preceding field. If an asterisk is used to specify the starting position, the
current logical default will be assumed. An asterisk in the length position will select the current
default for both length and prec. This is illegal: (3,8.*).
Any data in the record that is not defined in a format is ignored.
The examples below assume a 32-byte record with a carriage return/line feed occupying the last 2
bytes of each record. The data below can be interpreted in different ways using different invar
statements:
ABCDEFGHIJ12345678901234567890<CR><LF>
|
|
|
| |
|
position 1
10
20
30 31 32
This example:
invar record=32 $(1,3) group dept #(11,4.2) x[3] (*,5) y;
will result in:
variable
group
dept
X1
X2
X3
Y
value
ABC
DEF
12.34
56.78
90.12
34567
type
character
character
numeric
numeric
numeric
numeric
This example:
invar record=32 $ dept (*,2) id # (*,5) wage (*,2) area
26-9
ATOG
The type change characters $ and # are used to toggle between character and numeric data type.
GAUSS User Guide
will result in:
variable
dept
id
WAGE
AREA
value
ABCDEFGH
IJ
12345
67
type
character
character
numeric
numeric
msym
Specifies the character in the input file that is to be interpreted as a missing value. This example:
msym &;
defines the character ‘&’ as the missing value character. The default ‘.’ (dot) will always be
interpreted as a missing value unless it is part of a numeric value.
nocheck
Optional; suppresses automatic checking of packed ASCII record length and output data type. The
default is to increase the record length by 2 bytes if the second record in a packed file starts with
cr/lf, and any files that have explicitly defined character data will be output in double precision
regardless of the type specified.
output
The name of the GAUSS data set. A file will be created with the extension .dat. For example:
output /gauss/dat/test;
creates the file test.dat on the /gauss/dat directory.
26-10
ATOG
outtyp
Selects the numerical accuracy of the output file. Use of this command should be dictated by the
accuracy of the input data and storage space limitations. The format is:
ATOG
outtyp fmt;
where fmt is:
D or 8
F or 4
I or 2
double precision
single precision (default)
integer
The ranges of the different formats are:
bytes
data type
significant
digits
2
4
8
integer
single precision
double precision
4
6–7
15–16
range
−32768<=X<=32767
8.43x10−37 <=|X|<=3.37x10+38
4.19x10−307 <=|X|<=1.67x10+308
If the output type is integer, the input numbers will be truncated to integers. If your data has more
than 6 or 7 significant digits, specify outtyp as double.
Character data require outtyp d. ATOG automatically selects double precision when character
data is specified in the invar statement, unless you have specified nocheck.
The precision of the storage selected does not affect the accuracy of GAUSS calculations using the
data. GAUSS converts all data to double precision when the file is read.
outvar
Selects the variables to be placed in the GAUSS data set. The outvar command needs only the
list of variables to be included in the output data set. They can be in any order. In this example:
26-11
GAUSS User Guide
invar $name #age pay $sex #var[1:10] x[005];
outvar sex age x001 x003 var[1:8];
the outvar statement selects the following variables:
column
1
2
3
4
5
6
7
8
9
10
11
12
name
sex
AGE
X001
X003
VAR01
VAR02
VAR03
VAR04
VAR05
VAR06
VAR07
VAR08
data type
character
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
numeric
outvar is not used with packed ASCII files.
preservecase
Optional; preserves the case of variable names. The default is nopreservcase, which will force
variable names for numeric variables to upper case and character variables to lower case.
26.3
Examples
Example 1 The first example is a soft delimited ASCII file called agex1.asc. The file contains
seven columns of ASCII data:
26-12
ATOG
Jan 167.3 822.4 6.34E06 yes 84.3 100.4
Feb 165.8 987.3 5.63E06 no 22.4 65.6
Mar 165.3 842.3 7.34E06 yes 65.4 78.3
ATOG
The ATOG command file is agex1.cmd:
input /gauss/agex1.asc;
output agex1;
invar $month #temp pres vol $true var[02];
outvar month true temp pres vol;
The output data set will contain the following information:
name
case 1
case 2
case 3
type
month
Jan
Feb
Mar
char
true
yes
no
yes
char
TEMP
167.3
165.8
165.3
numeric
PRES
822.4
987.3
842.3
numeric
VOL
6.34e+6
5.63e+6
7.34e+6
numeric
The data set is double precision since character data is explicitly specified.
Example 2 The second example is a packed ASCII file xlod.asc The file contains 32-character
records:
AEGDRFCSTy02345678960631567890<CR><LF>
EDJTAJPSTn12395863998064839561<CR><LF>
GWDNADMSTy19827845659725234451<CR><LF>
|
|
|
| |
|
position 1
10
20
30 31 32
The ATOG command file is xlod.cmd:
26-13
GAUSS User Guide
input /gauss/dat/xlod.asc;
output xlod2;
invar record=32 $(1,3) client[2] zone (*,1) reg #(20,5) zip;
The output data set will contain the following information:
name
case 1
case 2
case 3
type
client1
AEG
EDJ
GWD
char
client2
DRF
TAJ
NAD
char
zone
CST
PST
MST
char
reg
y
n
y
char
ZIP
60631
98064
59725
numeric
The data set is double precision since character data is explicitly specified.
Example 3 The third example is a hard delimited ASCII file called cplx.asc. The file contains
six columns of ASCII data:
456.4, 345.2,
-257.6, 624.3,
602.3, -333.4,
533.2, -345.5, 524.5, 935.3,
639.5, 826.5, 331.4, 376.4,
342.1, 816.7, -452.6, -690.8
The ATOG command file is cplx.cmd:
input /gauss/cplx.asc;
output cplx;
invar delimit #cvar[3];
complex;
The output data set will contain the following information:
name
case 1
case 2
case 3
type
26-14
cvar1
456.4 + 345.2i
-257.6 + 624.3i
602.3 - 333.4i
numeric
cvar2
533.2 - 345.5i
639.5 + 826.5i
342.1 + 816.7i
numeric
cvar3
524.5 + 935.3i
331.4 + 376.4i
-452.6 - 690.8i
numeric
ATOG
The data set defaults to single precision, since no character data is present, and no outtyp
command is specified.
ATOG
26.4
Error Messages
atog - Can’t find input file
The ASCII input file could not be opened.
atog - Can’t open output file
The output file could not be opened.
atog - Can’t open temporary file
Notify Aptech Systems.
atog - Can’t read temporary file
Notify Aptech Systems.
atog - Character data in output file
Setting output file to double precision
The output file contains character data. The type was set to double precision
automatically.
atog - Character data longer than 8 bytes were truncated
The input file contained character elements longer than 8 bytes. The conversion
continued and the character elements were truncated to 8 bytes.
atog - Disk Full
The output disk is full. The output file is incomplete.
atog - Found character data in numeric field
26-15
GAUSS User Guide
This is a warning that character data was found in a variable that was specified as
numeric. The conversion will continue.
atog - Illegal command
An unrecognizable command was found in a command file.
atog - Internal error
Notify Aptech Systems.
atog - Invalid delimiter
The delimiter following the backslash is not supported.
atog - Invalid output type
Output type must be I, F, or D.
atog - Missing value symbol not found
No missing value was specified in an msym statement.
atog - No Input file
No ASCII input file was specified. The input command may be missing.
atog - No input variables
No input variable names were specified. The invar statement may be missing.
atog - No output file
No output file was specified. The output command may be missing.
atog - output type d required for character data
Character data in output file will be lost
Output file contains character data and is not double precision.
26-16
ATOG
atog - Open comment
The command file has a comment that is not closed. Comments must be enclosed in @’s:
@ comment @
ATOG
atog - Out of memory
Notify Aptech Systems.
atog - read error
A read error has occurred while converting a packed ASCII file.
atog - Record length must be 1-16384 bytes
The record subcommand has an out of range record length.
atog - Statement too long
Command file statements must be less than 16384 bytes.
atog - Syntax error at:
There is unrecognizable syntax in a command file.
atog - Too many input variables
More input variables were specified than available memory permitted.
atog - Too many output variables
More output variables were specified than available memory permitted.
atog - Too many variables
More variables were specified than available memory permitted.
atog - Undefined variable
26-17
GAUSS User Guide
A variable requested in an outvar statement was not listed in an invar statement.
atog WARNING: missing ‘)’ at:
The parentheses in the delimit subcommand were not closed.
atog WARNING: some records begin with cr/lf
A packed ASCII file has some records that begin with a carriage return/linefeed. The
record length may be wrong.
atog - complex illegal for packed ASCII file.
A complex command was encountered following an invar command with record
specified.
atog - Cannot read packed ASCII. (complex specified)
An invar command with record specified was encountered following a complex
command.
26-18
Error Messages
The following is a list of error messages intrinsic to the GAUSS programming language. Error
messages generated by library functions are not included here.
G0002 File too large
load
Input file too large.
getf
Input file too large.
G0003 Indexing a matrix as a vector
A single index can be used only on vectors. Vectors have only one row or only one
column.
G0004 Compiler stack overflow - too complex
An expression is too complex. Break it into smaller pieces. Notify Aptech Systems.
27-1
Error
Messages
27
GAUSS User Guide
G0005 File is already compiled
G0006 Statement too long
Statement longer than 4000 characters.
G0007 End of file encountered
G0008 Syntax error
Compiler
Unrecognizable or incorrect syntax. Semicolon missing on previous
statement.
create
Unrecognizable statement in command file, or numvar or outvar
statement error.
G0009 Compiler pass out of memory
Compiler pass has run out of memory. Notify Aptech Systems.
G0010 Can’t open output file
G0011 Compiled file must have correct extension
GAUSS requires a .gcg extension.
G0012 Invalid drive specifier
G0013 Invalid filename
G0014 File not found
G0015 Directory full
G0016 Too many #include’s
#include’d files are nested too deep.
27-2
Error Messages
G0017 WARNING: local outside of procedure
A local statement has been found outside a procedure definition. The local statement
will be ignored.
G0018 Read error in program file
G0019 Can’t edit .gcg file
Error
Messages
G0020 Not implemented yet
Command not supported in this implementation.
G0021 use must be at the beginning of a program
G0022 User keyword cannot be used in expression
G0023 Illegal attempt to redefine symbol to an index variable
G0024 Invalid use of ->, probably should be .
G0025 Undefined symbol
A symbol has been referenced that has not been given a definition.
G0026 Too many symbols
The global symbol table is full. (To set the limit, see new in the GAUSS L
R.)
G0027 Invalid directory
G0028 Can’t open configuration file
GAUSS cannot find the configuration file.
27-3
GAUSS User Guide
G0029 Missing left parenthesis
G0030 Insufficient workspace memory
The space used to store and manipulate matrices and strings is not large enough for the
operations attempted. (To make the main program space smaller and reclaim enough
space to continue, see new in the GAUSS L R.)
G0031 Execution stack too deep - expression too complex
An expression is too complex. Break it into smaller pieces. Notify Aptech Systems.
G0032 fn function too large
G0033 Missing right index bracket
G0034 Missing arguments
G0035 Argument too large
G0036 Matrices are not conformable
For a description of the function or operator being used and conformability rules, see
M O, Section 11.2, or the GAUSS L R.
G0037 Result too large
The size of the result of an expression is greater than the limit for a single matrix.
G0038 Not all the eigenvalues can be computed
G0039 Matrix must be square to invert
G0040 Not all the singular values can be computed
G0041 Argument must be scalar
27-4
Error Messages
A matrix argument was passed to a function that requires a scalar.
G0042 Matrix must be square to compute determinant
G0043 Not implemented for complex matrices
G0044 Matrix must be real
G0045 Attempt to write complex data to real data set
G0046 Columns don’t match
The matrices must have the same number of columns.
G0047 Rows don’t match
The matrices must have the same number of rows.
G0048 Matrix singular
The matrix is singular using the current tolerance.
G0049 Target matrix not complex
G0050 Out of memory for program
The main program area is full. (To increase the main program space, see new in the
GAUSS L R.)
G0051 Program too large
The main program area is full. (To increase the main program space, see new in the
GAUSS L R.)
G0052 No square root - negative element
27-5
Error
Messages
Data sets, unlike matrices, cannot change from real to complex after they are created.
Use create complex to create a complex data set.
GAUSS User Guide
G0053 Illegal index
An illegal value has been passed in as a matrix index.
G0054 Index overflow
An illegal value has been passed in as a matrix index.
G0055 retp outside of procedure
A retp statement has been encountered outside a procedure definition.
G0056 Too many active locals
The execution stack is full. There are too many local variables active. Restructure your
program. Notify Aptech Systems.
G0057 Procedure stack overflow - expression too complex
The execution stack is full. There are too many nested levels of procedure calls.
Restructure your program. Notify Aptech Systems.
G0058 Index out of range
You have referenced a matrix element that is out of bounds for the matrix being
referenced.
G0059 exec command string too long
G0060 Nonscalar index
G0061 Cholesky downdate failed
G0062 Zero pivot encountered
crout
27-6
The Crout algorithm has encountered a diagonal element equal to 0.
Use croutp instead.
Error Messages
G0063 Operator missing
An expression contains two consecutive operands with no intervening operator.
G0064 Operand missing
An expression contains two consecutive operators with no intervening operand.
G0065 Division by zero!
You are attempting to use compiled code from a previous version of GAUSS. Recompile
the source code under the current version.
G0068 Program compiled under GAUSS-386 real version
G0069 Program compiled under GAUSS-386i complex version
G0070 Procedure calls too deep
You may have a runaway recursive procedure.
G0071 Type mismatch
You are using an argument of the wrong data type (e.g., inputting a matrix when a string
is called for).
G0072 Too many files open
The limit on simultaneously open files is 10.
G0073 Redefinition of
declare
An attempt has been made to initialize a variable that is already
initialized. This is an error when declare := is used. declare !=
or declare ?= may be a better choice for your application.
27-7
Error
Messages
G0066 Must be recompiled under current version
GAUSS User Guide
declare
An attempt has been made to redefine a string as a matrix or
procedure, or vice versa. delete the symbol and try again. If this
happens in the context of a single program, you have a programming
error. If this is a conflict between different programs, use a new
statement before running the second program.
let
A string is being forced to type matrix. Use an external matrix
symbol; statement before the let statement.
G0074 Can’t run program compiled under GAUSS Light
G0075 gscroll input vector the wrong size
G0076 Call Aptech Systems Technical Support
G0077 New size cannot be zero
You cannot reshape a matrix to a size of zero.
G0078 vargetl outside of procedure
G0079 varputl outside of procedure
G0080 File handle must be an integer
G0081 Error renaming file
G0082 Error reading file
G0083 Error creating temporary file
G0084 Too many locals
A procedure has too many local variables.
27-8
Error Messages
G0085 Invalid file type
You cannot use this kind of file in this way.
G0086 Error deleting file
G0087 Couldn’t open
The auxiliary output file could not be opened. Check the file name and make sure there
is room on the disk.
Error
Messages
G0088 Not enough memory to convert the whole string
G0089 WARNING: duplicate definition of local
G0090 Label undefined
Label referenced has no definition.
G0091 Symbol too long
Symbols can be no longer than 32 characters.
G0092 Open comment
A comment was never closed.
G0093 Locate off screen
G0094 Argument out of range
G0095 Seed out of range
G0096 Error parsing string
parse encountered a token that was too long.
27-9
GAUSS User Guide
G0097 String not closed
A string must have double quotes at both ends.
G0098 Invalid character for imaginary part of complex number
G0099 Illegal redefinition of user keyword
G0100 Internal E R R O R ###
Notify Aptech Systems.
G0101 Argument cannot be zero
The argument to ln or log cannot be zero.
G0102 Subroutine calls too deep
Too many levels of gosub. Restructure your program.
G0103 return without gosub
You have encountered a subroutine without executing a gosub.
G0104 Argument must be positive
G0105 Bad expression or missing arguments
Check the expression in question, or you forgot an argument.
G0106 Factorial overflow
G0107 Nesting too deep
Break the expression into smaller statements.
G0108 Missing left bracket [
27-10
Error Messages
G0109 Not enough data items
You omitted data in a let statement.
G0110 Found ) expected ] G0111 Found ] expected ) G0112 Matrix multiplication overflow
Error
Messages
G0113 Unclosed (
G0114 Unclosed [
G0115 Illegal redefinition of function
You are attempting to turn a function into a matrix or string. If this is a name conflict,
delete the function.
G0116 sysstate:
invalid case
G0117 Invalid argument
G0118 Argument must be integer
File handles must be integral.
G0120 Illegal type for save
G0121 Matrix not positive definite
The matrix is either not positive definite, or singular using the current tolerance.
G0122 Bad file handle
The file handle does not refer to an open file or is not in the valid range for file handles.
27-11
GAUSS User Guide
G0123 File handle not open
The file handle does not refer to an open file.
G0124 readr call too large
You are attempting to read too much in one call.
G0125 Read past end of file
You have already reached the end of the file.
G0126 Error closing file
G0127 File not open for write
G0128 File already open
G0129 File not open for read
G0130 No output variables specified
G0131 Can’t create file, too many variables
G0132 Can’t write, disk probably full
G0133 Function too long
G0134 Can’t seekr in this type of file
G0135 Can’t seek to negative row
G0136 Too many arguments or misplaced assignment operator
You have an assignment operator (=) where you want a comparison operator (= =), or
you have too many arguments.
27-12
Error Messages
G0137 Negative argument - erf or erfc
G0138 User keyword must have one argument
G0139 Negative parameter - Incomplete Beta
G0140 Invalid second parameter - Incomplete Beta
Error
Messages
G0141 Invalid third parameter - Incomplete Beta
G0142 Nonpositive parameter - gamma
G0143 NaN or missing value - cdfchic
G0144 Negative parameter - cdfchic
G0145 Second parameter < 1.0 - cdfchic
G0146 Parameter too large - Incomplete Beta
G0147 Bad argument to trig function
G0148 Angle too large to trig function
G0149 Matrices not conformable
For a description of the function or operator being used and conformability rules, see
M O, Section 11.2, or the GAUSS L R.
G0150 Matrix not square
G0151 Sort failure
27-13
GAUSS User Guide
G0152 Variable not initialized
You have referenced a variable that has not been initialized to any value.
G0153 Unsuccessful close on auxiliary output
The disk may be full.
G0154 Illegal redefinition of string
G0155 Nested procedure definition
A proc statement was encountered inside a procedure definition.
G0156 Illegal redefinition of procedure
You are attempting to turn a procedure into a matrix or string. If this is a name conflict,
delete the procedure.
G0157 Illegal redefinition of matrix
G0158 endp without proc
You are attempting to end a procedure that you never started.
G0159 Wrong number of parameters
You called a procedure with the wrong number of arguments.
G0160 Expected string variable
G0161 User keywords return nothing
G0162 Can’t save proc/keyword/fn with global references
Remove the global references or leave this in source code form for the autoloader to
handle. (See library in the GAUSS L R.)
27-14
Error Messages
G0163 Wrong size format matrix
G0164 Bad mask matrix
G0165 Type mismatch or missing arguments
G0166 Character element too long
The maximum length for character elements is 8 characters.
Error
Messages
G0167 Argument must be column vector
G0168 Wrong number of returns
The procedure was defined to return a different number of items.
G0169 Invalid pointer
You are attempting to call a local procedure using an invalid procedure pointer.
G0170 Invalid use of ampersand
G0171 Called symbol is wrong type
You are attempting to call a local procedure using a pointer to something else.
G0172 Can’t resize temporary file
G0173 varindx failed during open
The global symbol table is full.
G0174 ‘‘.’’
and ‘‘ ’’ operators must be inside [ ] brackets
These operators are for indexing matrices.
27-15
GAUSS User Guide
G0175 String too long to compare
G0176 Argument out of range
G0177 Invalid format string
G0178 Invalid mode for getf
G0179 Insufficient heap space
G0180 Trim too much
You are attempting to trim more rows than the matrix has.
G0181 Illegal assignment - type mismatch
G0182 2nd and 3rd arguments different order
G0274 Invalid parameter for conv
G0275 Parameter is NaN (Not A Number)
The argument is a NaN (see S D T, Section 10.6.9).
G0276 Illegal use of reserved word
G0277 Null string illegal here
G0278 proc without endp
You must terminate a procedure definition with an endp statement.
G0286 Multiple assign out of memory
G0287 Seed not updated
27-16
Error Messages
The seed argument to rndns and rndus must be a simple local or global variable
reference. It cannot be an expression or constant. These functions are obsolete, please
use rndlcn and rndlcu
G0288 Found break not in do loop
G0289 Found continue not in do loop
G0290 Library not found
G0291 Compiler pass out of memory
Notify Aptech Systems.
G0292 File listed in library not found
A file listed in a library could not be opened.
G0293 Procedure has no definition
The procedure was not initialized. Define it.
G0294 Error opening temporary file
One of the temporary files could not be opened. The directory may be full.
G0295 Error writing temporary file
One of the temporary files could not be written to. The disk may be full.
G0296 Can’t raise negative number to nonintegral power
G0300 File handle must be a scalar
G0301 Syntax error in library
27-17
Error
Messages
The specified library cannot be found on the lib_path path. Make sure installation was
correct.
GAUSS User Guide
G0302 File has been truncated or corrupted
getname
File header cannot be read.
load
Cannot read input file, or file header cannot be read.
open
File size does not match header specifications, or file header cannot
be read.
G0317 Can’t open temp file
G0336 Disk full
G0339 Can’t debug compiled program
G0341 File too big
G0347 Can’t allocate that many globals
G0351 Warning:
Not reinitializing :
declare ?=
The symbol is already initialized. It will be left as is.
G0352 Warning:
Reinitializing :
declare !=
The symbol is already initialized. It will be reset.
G0355 Wrong size line matrix
G0360 Write error
G0364 Paging error
G0365 Unsupported executable file type
27-18
Error Messages
G0368 Unable to allocate translation space
G0369 Unable to allocate buffer
G0370 Syntax Error in code statement
G0371 Syntax Error in recode statement
G0372 Token verify error
Error
Messages
Notify Aptech Systems.
G0373 Procedure definition not allowed
A procedure name appears on the left side of an assignment operator.
G0374 Invalid make statement
G0375 make Variable is a Number
G0376 make Variable is Procedure
G0377 Cannot make Existing Variable
G0378 Cannot make External Variable
G0379 Cannot make String Constant
G0380 Invalid vector statement
G0381 vector Variable is a Number
G0382 vector Variable is Procedure
27-19
GAUSS User Guide
G0383 Cannot vector Existing Variable
G0384 Cannot vector External Variable
G0385 Cannot vector String Constant
G0386 Invalid extern statement
G0387 Cannot extern number
G0388 Procedures always external
A procedure name has been declared in an extern statement. This is a warning only.
G0389 extern variable already local
A variable declared in an extern statement has already been assigned local status.
G0390 String constant cannot be external
G0391 Invalid code statement
G0392 code Variable is a Number
G0393 code Variable is Procedure
G0394 Cannot code Existing Variable
G0395 Cannot code External Variable
G0396 Cannot code String Constant
G0397 Invalid recode statement
27-20
Error Messages
G0398 recode Variable is a Number
G0399 recode Variable is Procedure
G0400 Cannot recode External Variable
G0401 Cannot recode String Constant
G0402 Invalid keep statement
Error
Messages
G0403 Invalid drop statement
G0404 Cannot define Number
G0405 Cannot define String
G0406 Invalid select statement
G0407 Invalid delete statement
G0408 Invalid outtyp statement
G0409 outtyp already defaulted to 8
Character data has been found in the output data set before an outtyp 2 or outtyp 4
statement. This is a warning only.
G0410 outtyp must equal 2, 4, or 8
G0411 outtyp override...precision set to 8
Character data has been found in the output data set after an outtyp 2 or outtyp 4
statement. This is a warning only.
27-21
GAUSS User Guide
G0412 default not allowed in recode statement
default allowed only in code statement.
G0413 Missing file name in dataloop statement
G0414 Invalid listwise statement
G0415 Invalid lag statement
G0416 lag variable is a number
G0417 lag variable is a procedure
G0418 Cannot lag External Variable
G0419 Cannot lag String Constant
G0421 Command not supported in Run-Time Module
G0428 Cannot use debug command inside program
G0429 Invalid number of subdiagonals
G0431 Error closing dynamic library
G0432 Error opening dynamic library
G0433 Cannot find DLL function
G0434 Error opening default dynamic library
G0435 Invalid mode
27-22
Error Messages
G0436 Matrix is empty
G0437 loadexe not supported; use dlibrary instead
G0438 callexe not supported; use dllcall instead
G0439 File has wrong bit order
Error
Messages
G0440 File has wrong byte order
G0441 Type vector malloc failed
G0442 No type vector in gfblock
G0445 Illegal left-hand side reference in procedure
G0446 Argument is the wrong size
G0447 vfor called with illegal loop level
G0454 Failure opening printer for output
G0456 Failure buffering output for printer
G0457 Cannot take log of a negative number
G0458 Attempt to index proc/fn/keyword as a matrix
G0459 Missing right brace
G0460 Unexpected end of statement
27-23
GAUSS User Guide
G0461 Too many data items
G0462 Negative trim value
G0463 Failure generating graph
G0465 Redefinition of structure, number of elements
G0466 Redefinition of structure, type mismatch
G0467 Redefinition of structure, unrecognized member
G0468 Structure definition inside procedure definition
G0469 Cannot create translator temp file
G0470 Symbol not found
G0472 Invalid name
G0473 String not terminated with null byte
G0477 FOR loops nested too deep
G0486 Character argument too long
G0487 License expired
G0490 License manager initialization error
G0491 License manager error
27-24
Error Messages
G0492 Licensing failure
G0497 Missing right parenthesis
G0500 Cannot create temporary filename
G0503 Cannot assign matrix to scalar member
Error
Messages
G0504 Invalid structure member
G0505 Invalid structure redefinition
G0506 Structure assignment mismatch
G0507 Undefined structure
G0508 Structure argument mismatch
G0509 Too many structure members
G0510 Duplicate name for structure member
G0514 Not supported for structures
G0515 Too many values in locator
G0516 Too many dimensions in result
G0517 Too many dimensions in argument
G0518 Not implemented for complex
27-25
GAUSS User Guide
G0519 Illegal dereference of structure array
G0520 Arguments not conformable
G0521 Argument must be real
G0522 Illegal indexing of dereferenced structure
G0523 Numeric argument must be integer
G0524 Found comma, expecting index
G0525 Argument contains NaNs
G0526 Argument must be compact format
G0529 Array orders must be >= 1
G0531 Two trailing dimensions of argument must be the same size
G0532 Both dimensions of argument must be the same size
G0533 1-dimensional argument must contain only 1 element
G0534 Cannot create file
G0538 Zero illegal in for loop increment
G0541 Illegal assignment to FOR loop counter
G0542 Object too large for 32-bit version
27-26
Error Messages
G0543 Array has too many dimensions for matrix assign
G0547 Array not conformable for indexing
G0548 Array not conformable for boolean operation
G0549 Global structure pointer cannot point to local structure
Error
Messages
G0550 Invalid use of *
G0551 Feature not authorized
G0553 Path too long
27-27
Maximizing Performance
28
Performance
These hints will help you maximize the performance of your new GAUSS System.
28.1
Library System
Some temporary files are created during the autoloading process. If you have a tmp_path
configuration variable or a tmp environment string that defines a path on a RAM disk, the
temporary files will be placed on the RAM disk.
For example:
set tmp=f:\tmp
tmp_path takes precedence over the tmp environment variable.
A disk cache will also help, as well as having your frequently used files in the first path in the
src_path.
28-1
GAUSS User Guide
You can optimize your library .lcg files by putting the correct drive and path on each file name
listed in the library. The lib command will do this for you.
Use the compile command to precompile your large frequently used programs. This will
completely eliminate compile time when the programs are rerun.
28.2
Loops
The use of the built-in matrix operators and functions rather than do loops will ensure that you are
utilizing the potential of GAUSS.
Here is an example:
Given the vector x with 8000 normal random numbers,
x = rndn(8000,1);
you could get a count of the elements with an absolute value greater than 1 with a do loop, like
this:
c = 0;
i = 1;
do while i <= rows(x);
if abs(x[i]) > 1;
c = c+1;
endif;
i = i+1;
endo;
print c;
Or, you could use:
28-2
Maximizing Performance
c = sumc(abs(x) .> 1);
print c;
The do loop takes over 40 times longer.
28.3
Memory Usage
Computers today can have large amounts of RAM. This doesn’t mean that large data sets should
be read entirely into memory. Many GAUSS procedures and applications are written to allow for
data sets to be read in sections rather than all at once. Even if you have enough RAM to store the
data set completely, you should consider taking advantage of this feature. The speed-ups using this
feature can be significant. For example, ols is called using a data set stored in a matrix versus
stored on the disk in a GAUSS data set. The computer is a 2.8 Megahertz computer with Windows
XP.
Performance
y = rndn(250000,1);
x = rndn(250000,100);
xlbl = 0$+"X"+ftocv(seqa(1,1,100),1,0);
lbl = "Y" | xlbl;
call saved(y˜x,"test",lbl);
__output = 0;
t0 = date;
call ols("",y,x);
t1 = date;
t2 = date;
call ols("test","Y",xlbl);
t3 = date;
print ethsec(t2,t3)/100 " seconds;
print;
print ethsec(t0,t1)/100 " seconds";
25.750000 seconds
9.6720000 seconds
28-3
GAUSS User Guide
This represents more than a 50% speedup by leaving the data on the disk.
maxvec,maxbytes
maxvec is a GAUSS procedure that returns the value of the global variable __maxvec that
determines the amount of data to be read in at a time from a GAUSS data set. This value can be
modified for a particular run by setting __maxvec in your command file to some other value. The
value returned by a call to maxvec can be permanently modified by editing system.dec and
changing the value of __maxvec. The value returned when running GAUSS Light is always 8192.
maxbytes is a GAUSS procedure that returns the value of a scalar global __maxbytes that sets
the amount of available RAM. This value can be modified for a particular run by setting
__maxbytes in your command file to some other value. The value returned by a call to maxbytes
can be permanently modified by editing system.dec and changing the value of __maxbytes.
If you wish to force GAUSS procedures and applications to read a GAUSS data set in its entirety,
set __maxvec and __maxbytes to very large values.
28.3.1
Hard Disk Maintenance
The hard disk used for the swap file should be optimized occasionally with a disk optimizer. Use a
disk maintenance program to ensure that the disk media is in good shape.
28.3.2
CPU Cache
There is a line for cache size in the gauss.cfg file. Set it to the size of the CPU data cache for
your computer.
This affects the choice of algorithms used for matrix multiply functions.
This will not change the results you get, but it can radically affect performance for large matrices.
28-4
Fonts
A
There are four fonts available in the Publication Quality Graphics System:
Simplex
Simgrma
Microb
complex
standard sans serif font
Simplex greek, math
bold and boxy
standard font with serif
Fonts
The following tables show the characters available in each font and their ASCII values. (For
details on selecting fonts for your graph, see S F, Section 24.4.1.
“ttfamily “bfseries “upshape LaTeX Error: File ‘simplex’ not found.ΩΩSee the LaTeX manual or LaTeX Comp
A.1
Simplex
“ttfamily “bfseries “upshape LaTeX Error: File ‘simgrma’ not found.ΩΩSee the LaTeX manual or LaTeX Com
A.2
Simgrma
“ttfamily “bfseries “upshape LaTeX Error: File ‘microb’ not found.ΩΩSee the LaTeX manual or LaTeX Comp
A.3
Microb
“ttfamily “bfseries “upshape LaTeX Error: File ‘complex’ not found.ΩΩSee the LaTeX manual or LaTeX Com
A.4
Complex
A-1
Reserved Words Appendix
B
The following words are used for GAUSS functions. You cannot use these names for variables or
procedures in your programs:
A
AmericanBSCall
AmericanBSCall_Greeks
AmericanBSCall_ImpVol
AmericanBSPut
AmericanBSPut_Greeks
AmericanBSPut_ImpVol
amin
amult
and
annualTradingDays
arccos
arcsin
arctan
Reserved
Words
abs
acf
aconcat
acos
aeye
amax
amean
AmericanBinomCall
AmericanBinomCall_Greeks
AmericanBinomCall_ImpVol
AmericanBinomPut
AmericanBinomPut_Greeks
AmericanBinomPut_ImpVol
B-1
GAUSS User Guide
arctan2
areshape
arrayalloc
arrayindex
arrayinit
arraytomat
asclabel
asin
asum
atan
atan2
atranspose
axmargin
balance
band
bandchol
bandcholsol
bandltsol
bandrv
bandsolpd
bar
base10
begwind
besselj
bessely
box
boxcox
break
calcbox
call
callexe
cdfbeta
cdfbvn
cdfbvn2
cdfbvn2e
cdfchic
cdfchii
cdfchinc
cdffc
cdffnc
cdfgam
cdfmvn
cdfn
cdfn2
cdfnc
cdfni
cdftc
cdftci
cdftnc
cdftvn
cdir
ceil
cfft
cffti
changedir
chdir
B
C
B-2
Reserved Words Appendix
cons
continue
contour
conv
convertsatostr
convertstrtosa
coreleft
corrm
corrms
corrvc
corrx
corrxs
cos
cosh
counts
countwts
create
crossprd
crout
croutp
csrcol
csrlin
csrtype
cumprodc
cumsumc
curve
cvtos
cvtosa
datacreate
datacreatecomplex
datalist
dataload
dataopen
datasave
date
datestr
Reserved
Words
checkinterrupt
chol
choldn
cholsol
cholup
chrs
cint
clear
clearg
close
closeall
cls
cmsplit
cmsplit2
code
color
cols
colsf
combinate
combinated
comlog
commandeerm
commandeersa
compile
complex
con
cond
conformed
conj
D
B-3
GAUSS User Guide
datestring
datestrymd
dayinyr
dayOfWeek
debug
declare
delete
deletefile
delif
denseSubmat
design
det
detl
dfft
dffti
dfree
diag
diagrv
digamma
disable
dlibrary
dllcall
do
dos
doswincloseall
doswinopen
dotfeq
dotfeqmt
dotfge
dotfgemt
dotfgt
dotfgtmt
dotfle
dotflemt
dotflt
dotfltmt
dotfne
dotfnemt
draw
dsCreate
dstat
dstatmt
dstatmtControlCreate
dtdate
dtday
dttime
dttodtv
dttostr
dttoutc
dtvnormal
dtvtodt
dtvtoutc
dummy
dummybr
dummydn
ed
edit
editm
eig
eigcg
eigcg2
eigch
eigch2
eigh
eighv
E
B-4
Reserved Words Appendix
eigrg
eigrg2
eigrs
eigrs2
eigv
elapsedTradingDays
else
elseif
enable
end
endfor
endif
endo
endp
endwind
envget
eof
eq
eqSolve
eqSolvemt
eqSolvemtControlCreate
eqSolvemtOutCreate
eqSolveSet
eqv
erf
erfc
error
errorlog
etdays
ethsec
etstr
EuropeanBinomCall
EuropeanBinomCall_Greeks
EuropeanBinomCall_ImpVol
EuropeanBinomPut
EuropeanBinomPut_Greeks
EuropeanBinomPut_ImpVol
EuropeanBSCall
EuropeanBSCall_Greeks
EuropeanBSCall_ImpVol
EuropeanBSPut
EuropeanBSPut_Greeks
EuropeanBSPut_ImpVol
exctsmpl
exec
execbg
exp
expr
external
eye
fcheckerr
fclearerr
feq
feqmt
fflush
fft
ffti
fftm
fftmi
fftn
fge
fgemt
fgets
fgetsa
fgetsat
fgetst
F
Reserved
Words
B-5
GAUSS User Guide
fgt
fgtmt
fileinfo
files
filesa
fix
fle
flemt
floor
flt
fltmt
fmod
fn
fne
fnemt
font
fontload
fonts
fontunload
fontunloadall
fopen
for
format
formatcv
formatnv
fputs
fputst
fseek
fstrerror
ftell
ftocv
ftos
ftostrc
gamma
gammaii
gausset
gdaappend
gdacreate
gdadstat
gdadstatmat
gdagetindex
gdagetname
gdagetnames
gdagetorders
gdagettype
gdagettypes
gdagetvarinfo
gdaiscplx
gdapack
gdaread
gdareadbyindex
gdareadsome
gdareportvarinfo
gdaupdate
gdaupdateandpack
gdawrite
gdawritesome
gdtfastcat
ge
getarray
getdims
getf
getmatrix
getmatrix4d
getname
G
B-6
Reserved Words Appendix
getnamef
getNextTradingDay
getNextWeekDay
getnr
getnrmt
getorders
getpath
getPreviousTradingDay
getPreviousWeekDay
getscalar3d
getscalar4d
getwind
gosub
goto
gradMT
gradMTm
gradp
graph
graphgpg
graphinit
graphprt
graphset
graphsev3
gt
hardcopy
hasimag
header
headermt
hess
hessMT
hessMTg
hessMTgw
hessMTm
hessMTmw
hessMTw
hessp
hist
histf
histp
hsec
if
imag
indcv
indexcat
indices
indices2
indicesf
indicesfn
indnv
indsav
int
intgrat2
intgrat3
inthp
intHP1
intHP2
H
I
Reserved
Words
B-7
GAUSS User Guide
intHP3
intHP4
inthpControlCreate
intquad1
intquad2
intquad3
intrleav
intrleavsa
intrsect
intrsectsa
intsimp
inv
invpd
invswp
iscplx
iscplxf
isinfnanmiss
ismiss
isSparse
key
keyav
keymatchmc
keyw
keyword
lag
lag1
lagn
lapeighb
lapeighi
lapeighvb
lapeighvi
lapgeig
lapgeigh
lapgeighv
lapgeigv
lapgschur
lapgsvdcst
lapgsvds
lapgsvdst
lapsvdcusv
lapsvds
lapsvdusv
le
let
lib
library
license_id
line
linsolve
ln
lncdfbvn
lncdfbvn2
lncdfmvn
lncdfn
lncdfn2
lncdfnc
K
L
B-8
Reserved Words Appendix
lnfact
lngamma
lnpdfmvn
lnpdfmvt
lnpdfn
lnpdft
load
loadarray
loadd
loadexe
loadf
loadk
loadm
loadp
loads
loadstruct
loadwind
local
locate
loess
loessmt
loessmtControlCreate
log
loglog
logx
logy
loopnextindex
lower
lowmat
lowmat1
lpos
lprint
lpwidth
lshow
lt
ltrisol
lu
lusol
machEpsilon
makevars
makewind
margin
matalloc
matinit
matrix
mattoarray
maxbytes
maxc
maxindc
maxvec
mbesselei
mbesselei0
mbesselei1
mbesseli
mbesseli0
mbesseli1
meanc
median
mergeby
mergebysa
mergevar
minc
minindc
miss
missex
missrv
M
Reserved
Words
B-9
GAUSS User Guide
moment
momentd
movingave
movingaveExpwgt
movingaveWgt
msym
nametype
ndpchk
ndpclex
ndpcntrl
ne
new
nextindex
nextn
nextnevn
nextwind
not
null
null1
numCombinations
oldfft
oldffti
ols
olsmt
olsmtControlCreate
olsqr
olsqr2
olsqrmt
ones
open
openpqg
optn
optnevn
or
orth
output
outwidth
pacf
packr
parse
pause
pdfn
pi
pinv
pinvmt
plot
plotsym
N
O
P
B-10
Reserved Words Appendix
polar
polychar
polyeval
polyint
polymake
polymat
polymroot
polymult
polyroot
pop
pqgwin
prcsn
previousindex
princomp
print
printdos
printfm
printfmt
proc
prodc
push
putarray
putf
pvCreate
pvgetindex
pvgetparnames
pvgetparvector
pvLength
pvList
pvnumoffsets
pvoffsets
pvPack
pvPacki
pvPackm
pvPackmi
pvPacks
pvPacksi
pvPacksm
pvPacksmi
pvputparvector
pvtest
pvunpack
QNewton
QNewtonmt
QNewtonmtControlCreate
QNewtonmtOutCreate
qnewtonset
QProg
QProgmt
qprogMTInCreate
qqr
qqre
qqrep
qr
qre
qrep
qrsol
qrtsol
qtyr
qtyre
qtyrep
quantile
quantiled
quantilem
quantilemd
qyr
Q
Reserved
Words
B-11
GAUSS User Guide
qyre
qyrep
rank
rankindx
readr
real
recode
recserar
recsercp
recserrc
register_off
register_on
register_reset
register_show
renamefile
replay
rerun
reshape
retp
return
rev
rfft
rffti
rfftip
rfftn
rfftnp
rfftp
rndbeta
rndcon
rndgam
rndi
rndKMbeta
rndKMgam
rndkmi
rndkmn
rndKMnb
rndKMp
rndkmu
rndKMvm
rndLCbeta
rndLCgam
rndlci
rndlcn
rndLCnb
rndLCp
rndlcu
rndLCvm
rndmod
rndmult
rndn
rndnb
rndns
rndp
rndseed
rndu
rndus
rndvm
rotater
round
rows
rowsf
rref
run
R
B-12
Reserved Words Appendix
S
sinh
sleep
solpd
sortc
sortcc
sortd
sorthc
sorthcc
sortind
sortindc
sortindmc
sortmc
sortr
sortrc
sparseCols
sparseEye
sparseFD
sparseFP
sparseHConcat
sparseNZE
sparseOnes
sparseRows
sparseScale
sparseSet
sparseSolve
sparseSubmat
sparseTD
sparseTranspose
sparseTrTD
sparseTscalar
sparseVConcat
spline
spline1D
spline2D
sqpmt_feasible
Reserved
Words
satocv
satostrC
save
saveall
saved
savestruct
savewind
scale
scale3d
scalerr
scalinfnanmiss
scalmiss
schtoc
schur
screen
scroll
searchsourcepath
seekr
selif
seqa
seqm
setarray
setcnvrt
setdif
setdifsa
setvars
setvmode
setvwrmode
setwind
shell
shiftr
show
showpqg
sin
singleindex
B-13
GAUSS User Guide
sqpmt_meritFunct
sqpSolve
SQPsolveMT
sqpSolveMTcontrolCreate
sqpSolveMTlagrangeCreate
sqpSolveMToutCreate
sqpSolveset
sqrt
stdc
stocv
stof
stop
strcombine
strindx
string
strlen
strput
strrindx
strsect
strsplit
strsplitpad
strtodt
strtodtd
strtof
strtofcplx
strtriml
strtrimr
strtrunc
strtruncl
strtruncpad
strtruncr
struct
submat
subscat
substute
subvec
sumc
sumr
surface
svd
svd1
svd2
svdcusv
svds
svdusv
sysstate
system
tab
tan
tanh
tempname
time
timedt
timestr
timeutc
title
tkf2eps
tkf2ps
tkf2ps_margin
tocart
todaydt
toeplitz
token
topolar
trace
T
B-14
Reserved Words Appendix
trap
trapchk
trigamma
trim
trimr
trunc
type
typecv
typef
union
unionsa
uniqindmc
uniqindx
uniqindxsa
unique
uniquemc
uniquesa
until
upmat
upmat1
upper
use
utctodt
utctodtv
utrisol
vals
varget
vargetl
varmall
varmares
varput
varputl
vartype
vartypef
vcm
vcms
vcx
vcxs
vec
vech
vecr
vfor
vget
view
viewxyz
vlist
vnamecv
volume
vput
vread
vtypecv
U
V
Reserved
Words
W
B-15
GAUSS User Guide
B-16
Reserved Words Appendix
wait
waitc
walkindex
while
winclear
wincleararea
winclearttylog
winclose
wincloseall
winconvertpqg
window
wingetactive
wingetattributes
wingetcolorcells
wingetcursor
winmove
winopenpqg
winopentext
winopentty
winpan
winprint
winprintpqg
winrefresh
winrefresharea
winresize
winsetactive
winsetbackground
winsetcolor
winsetcolorcells
winsetcolormap
winsetcursor
winsetforeground
winsetrefresh
winsettextwrap
winwrite
winzoompqg
writer
x_indcv
xlabel
xor
xpnd
xtics
xy
xyz
ylabel
ytics
X
Y
Reserved
Words
Z
B-17
GAUSS User Guide
zeros
zlabel
B-18
ztics
Singularity
Singularity Tolerance Appendix
C
The tolerance used to determine whether or not a matrix is singular can be changed. The default
value is 1.0e-14 for both the LU and the Cholesky decompositions. The tolerance for each
decomposition can be changed separately. The following operators are affected by a change in the
tolerance:
Crout LU Decomposition
crout(x)
croutp(x)
inv(x)
det(x)
y/x
when neither x nor y is scalar and x is square.
Cholesky Decomposition
chol(x)
invpd(x)
solpd(y,x)
y/x
when neither x nor y is scalar and x is not square.
C-1
GAUSS User Guide
C.1
Reading and Setting the Tolerance
The tolerance value may be read or set using the sysstate function, cases 13 and 14.
C.2
Determining Singularity
There is no perfect tolerance for determining singularity. The default is 1.0e-14. You can adjust
this as necessary.
A numerically better method of determining singularity is to use cond to determine the condition
number of the matrix. If the equation
1 / cond(x) + 1 eq 1
is true, then the matrix is usually considered singular to machine precision. (See LINPACK for a
detailed discussion on the relationship between the matrix condition and the number of significant
figures of accuracy to be expected in the result.)
C-2
Index
0 , 11-8
.0 , 11-8
∼ , 11-9
| , 11-8
! , 11-6
% , 11-5
∗ , 11-5
*∼ , 11-7
.* , 11-6
.*. , 11-6
+ , 11-4
− , 11-4
/ , 11-5
./ , 11-6
ˆ , 11-6, 11-19
.ˆ , 11-6
,
.
:
;
(comma) , 11-16
(dot) , 11-16
(colon) , 11-17
(semicolon) , 10-2
# , 22-3, 31-119, 31-120, 31-516, 31-682,
31-907
$ , 31-119, 31-120, 31-516, 31-682, 31-907
∼ , 11-19
$| , 11-19
$+ , 11-18
Index
Index
& , 11-17, 12-10
= , 10-2, 10-12, 10-40
= , 11-16
/ = , 11-11
./= , 11-12
= = , 10-40, 11-11
.= = , 11-12
> , 11-11
. > , 11-13
>= , 11-11
. >= , 11-12
< , 11-10
. < , 11-12
<= , 11-10
. <= , 11-12
__altnam, 31-240
__output, 31-240, 31-505, 31-800
__title, 31-240
__Tol, 31-240
_eqs_IterInfo, 31-240
_eqs_JacobianProc, 31-240
_eqs_MaxIters, 31-240
_eqs_StepTol, 31-240
_eqs_TypicalF, 31-240
_eqs_TypicalX, 31-240
_loess_Degree, 31-505
Index-1
Index
_loess_NumEval, 31-505
_loess_Span, 31-505
_loess_WgtType, 31-505
_sqp_A, 31-797
_sqp_B, 31-797
_sqp_Bounds, 31-798
_sqp_C, 31-798
_sqp_D, 31-798
_sqp_DirTol, 31-799
_sqp_EqProc, 31-797
_sqp_FeasibleTest, 31-799
_sqp_GradProc, 31-798
_sqp_HessProc, 31-799
_sqp_IneqProc, 31-798
_sqp_MaxIters, 31-799
_sqp_ParNames, 31-799
_sqp_PrintIters, 31-799
_sqp_RandRadius, 31-800
A
abs, 31-1
absolute value, 31-1
acf, 31-2
aconcat, 15-4, 31-3
additive sequence, 31-756
aeye, 15-6, 31-5
algebra, linear, 30-4
amax, 15-25, 31-6
amean, 15-25, 31-8
AmericanBinomCall, 31-10
AmericanBinomCall_Greeks, 31-11
AmericanBinomCall_ImpVol, 31-13
AmericanBinomPut, 31-14
AmericanBinomPut_Greeks, 31-15
AmericanBinomPut_ImpVol, 31-17
AmericanBSCall, 31-18
AmericanBSCall_Greeks, 31-19
Index-2
AmericanBSCall_ImpVol, 31-20
AmericanBSPut, 31-21
AmericanBSPut_Greeks, 31-22
AmericanBSPut_ImpVol, 31-23
amin, 15-25, 31-24
ampersand, 11-17
amult, 15-23, 31-26
and, 11-13, 11-14
.and, 11-15
annualTradingDays, 31-28
append, ATOG command, 26-3
arccos, 31-29
arcsin, 31-30
areshape, 15-2, 31-31
arguments, 10-40, 12-3, 12-7
array indexing, 14-3
arrayalloc, 15-7, 31-32
arrayindex, 31-33
arrayinit, 15-6, 31-34
arrays, 14-1, 15-1, 30-27
arrays of structures, 16-4
arraytomat, 15-28, 31-35
arrows, 24-14, 24-16
ASCII files, 26-1
ASCII files, packed, 26-8
ASCII files, reading, 20-3
ASCII files, writing, 20-4
asciiload, 31-36
asclabel, 31-37
assigning to arrays, 15-8
assignment operator, 10-2, 10-40, 11-16
astd, 31-38
astds, 31-40
asum, 31-42
atan, 31-44
atan2, 31-45
atog, 20-3
Index
B
backslash, 10-22
balance, 31-50
band, 31-51
bandchol, 31-52
bandcholsol, 31-53
bandltsol, 31-55
bandrv, 31-56
bandsolpd, 31-58
bar shading, 24-17
bar width, 24-18
bar, 31-58
base10, 31-60
batch mode, 3-1
begwind, 31-61
besselj, 31-61
bessely, 31-62
beta function, 31-67
binary file, loading, 31-360
binary files, 20-15
bivariate Normal, 31-69
blank lines, 10-38
bookmarks, 5-2
Boolean operators, 11-13
box, 24-18
box, 31-63
boxcox, 31-64
branching, 30-41
break, 31-65
Breakpoints, 5-8
browse, 3-3
Index
ATOG, 26-1
atranspose, 15-21, 31-46
autoloader, 10-4, 10-5, 18-1, 31-480
auxiliary output, 20-4, 31-574
auxiliary output, width, 31-577
axes, 24-17, 24-19
axes numbering, 24-26
axes, reversed, 31-929, 31-932
axmargin, 31-48
C
call, 31-66
calling a procedure, 12-6
caret, 11-6, 11-19
Cartesian coordinates, 31-930
case, 10-38, 31-511, 31-890
cdfbeta, 31-67
cdfbvn, 31-69
cdfbvn2, 31-71
cdfbvn2e, 31-73
cdfchic, 31-74
cdfchii, 31-76
cdfchinc, 31-77
cdffc, 31-78
cdffnc, 31-80
cdfgam, 31-81
cdfm.src, 31-84, 31-86, 31-87, 31-89,
31-90, 31-92
cdfmvn, 31-83
cdfmvn2e, 31-86
cdfmvnce, 31-83
cdfmvne, 31-85
cdfmvt2e, 31-91
cdfmvtce, 31-87
cdfmvte, 31-89
cdfn, 31-93
cdfn2, 31-95
cdfnc, 31-93
cdfni, 31-96
cdftc, 31-97
cdftci, 31-98
cdftnc, 31-99
Index-3
Index
cdftvn, 31-100
cdir, 31-102
ceil, 31-103
ChangeDir, 31-104
characteristic polynomial, 31-587
chdir, 31-104
chi-square, 31-74
chi-square, noncentral, 31-77
chiBarSquare, 31-105
chol, 31-106
choldn, 31-108
Cholesky decomposition, 0-1, 11-5, 31-107,
31-772
cholsol, 31-109
cholup, 31-110
chrs, 31-111
circles, 24-22
clear, 31-112
clearg, 31-112
close, 31-113
closeall, 31-115
cls, 31-116
code (dataloop), 31-119
code, 31-117
coefficient of determination, 31-554, 31-560
coefficients, 31-554, 31-559
coefficients, standardized, 31-554, 31-559
colon, 10-39
color, 24-19, 24-25
Colors, 0-1
colors, 0-1
cols, 31-120
colsf, 31-121
columns in a matrix, 31-120
combinate, 31-122
combinated, 31-123
comlog, 31-124
Index-4
comma, 11-16
command, 10-2
Command Input - Output Window, 5-4
command line, 3-1
comments, 10-38
comparison functions, 31-278, 31-280
comparison operator, 10-40
compilation phase, 22-3
compile, 19-1
compile options, 5-11
compile time, 10-1
compile, 31-125
compiled language, 10-1
compiler, 19-1
compiler directives, 30-39
compiling, 30-44
compiling files, 19-2
compiling programs, 19-2
complex constants, 10-14, 31-176, 31-474,
31-815
complex modulus, 31-1
complex, 26-4, 31-127
con, 31-128
concatenation, matrix, 11-8, 11-9
concatenation, string, 11-18
cond, 31-130
condition number, 31-130
conditional branching, 10-35
config, 3-3
conformability, 11-1
conj, 31-131
cons, 31-132
ConScore, 31-132
constants, complex, 10-14, 31-176, 31-474,
31-815
continue, 31-136
contour levels, 24-22
Index
cumulative sums, 31-158
cursor, 31-156, 31-504
curve, 31-159
cvtos, 31-160
Index
contour, 31-137
control flow, 10-32
control structures, 16-21
conv, 31-138
conversion, character to ASCII value, 31-895
conversion, float to ASCII, 31-316, 31-317
conversion, string to floating point, 31-814
convertsatostr, 31-139
convertstrtosa, 31-139
convolution, 31-138
coordinates, 24-6
correlation matrix, 31-140, 31-141, 31-554,
31-560
corrm, 31-140
corrms, 31-141
corrvc, 31-140
corrx, 31-140
corrxs, 31-141
cos, 31-141
cosh, 31-142
cosine, inverse, 31-29
counts, 31-143
countwts, 31-145
create, 31-146
cropping, 24-19
cross-product, 31-152
crossprd, 31-152
Crout decomposition, 31-153, 31-154
Crout LU decomposition, 0-1
crout, 31-153
croutp, 31-154
csrcol, 31-156
csrlin, 31-156
cumprodc, 31-157
cumsumc, 31-158
cumulative distribution function, 31-67
cumulative products, 31-157
D
data coding, 30-36
data handling, 30-30
data loop, 22-1
data sets, 20-7, 30-33
data transformations, 22-1, 31-117, 31-183
data, writing, 31-915
datacreate, 31-161
datacreatecomplex, 31-163
datalist, 31-165
dataload, 31-166
dataloop translator, 3-3
dataloop, 31-166
dataopen, 31-167
datasave, 31-169
date, 24-20, 31-170
date, 25-2, 31-170
datestr, 31-170
datestring, 31-171
datestrymd, 31-172
dayinyr, 31-172
dayofweek, 31-173
debug, 31-174
Debugger, 5-7
debugging, 3-4, 19-3, 30-47, 31-482
declare, 31-174
delete (dataloop), 31-181
delete, 31-180
DeleteFile, 31-182
deletion, 31-211, 31-213, 31-581
delif, 31-183
delimited, 26-1
Index-5
Index
delimited files, 20-3
delimited, hard, 26-6
delimited, soft, 26-5
denseToSp, 31-184
denseToSpRE, 31-185
denToZero, 31-186
derivatives, 31-380
derivatives, second partial, 31-397
descriptive statistics, 31-210, 31-212
design matrix, 31-187
design, 31-187
det, 31-188
determinant, 31-188
detl, 31-189
dfft, 31-190
dffti, 31-191
diag, 31-191
diagonal, 31-191
diagrv, 31-192
differentiation, 30-3
digamma, 31-193
dimension index, 14-2
dimension number, 14-2
directory, 31-102
division, 11-5
dlibrary, 21-1, 31-194
dllcall, 21-1, 31-195
do loop, 10-32
do until, 31-197
do while, 31-197
dos, 31-200
doswin, 31-202
DOSWinCloseall, 31-202
DOSWinOpen, 31-203
dot relational operator, 11-11, 11-21
dotmtfeq, 31-205
dotmtfeqmt, 31-206
Index-6
dotfge, 31-205
dotfgemt, 31-206
dotfgt, 31-205
dotfgtmt, 31-206
dotfle, 31-205
dotflemt, 31-206
dotflt, 31-205
dotfltmt, 31-206
dotfne, 31-205
dotfnemt, 31-206
downloading, 2-2
draw, 31-208
drop (dataloop), 31-209
DS structure, 16-14, 17-7
dsCreate, 31-210
dstat, 31-210
dstatmt, 31-212
dstatmtControlCreate, 31-214
dtdate, 31-215
dtday, 31-216
dttime, 31-216
dttodtv, 31-217
dttostr, 31-218
dttoutc, 31-220
dtv vector, 25-3
dtvnormal, 25-3, 31-221
dtvtodt, 31-222
dtvtoutc, 31-223
dummy variables, 31-224
dummy, 31-224
dummybr, 31-225
dummydn, 31-227
Durbin-Watson statistic, 31-553, 31-557
dynamic libraries, 21-3
E
E×E conformable, 11-1
Index
.eqv, 11-15
erf, 31-249
erfc, 31-249
error bar, 24-20
error code, 31-251, 31-746
error function, 31-249
error handling, 30-47
error messages, 27-1, 31-252, 31-482
Error Output Window, 5-7
error trapping, 31-875
error, 31-250
errorlog, 31-252
errorlogat, 31-252
escape character, 10-22
etdays, 31-253
ethsec, 31-254
etstr, 25-5, 31-255
EuropeanBinomCall, 31-255
EuropeanBinomCall_Greeks, 31-257
EuropeanBinomCall_ImpVol, 31-258
EuropeanBinomPut, 31-259
EuropeanBinomPut_Greeks, 31-260
EuropeanBinomPut_ImpVol, 31-262
EuropeanBSCall, 31-263
EuropeanBSCall_Greeks, 31-264
EuropeanBSCall_ImpVol, 31-265
EuropeanBSPut, 31-266
EuropeanBSPut_Greeks, 31-267
EuropeanBSPut_ImpVol, 31-269
exctsmpl, 31-270
exec, 31-271
execbg, 31-272
executable code, 10-4
executable statement, 10-3
execution phase, 22-4
execution time, 10-1
exp, 31-273
Index-7
Index
ed, 31-228
edit windows, 5-1
edit, 31-229
editing matrices, 6-1
editor, 31-229
editor properties, 5-2
editor, alternate, 31-229
Editor, Matrix, 6-1
eig, 31-230
eigenvalues, 30-9, 31-230
eigenvalues and eigenvectors, 31-233
eigh, 31-231
eighv, 31-232
eigv, 31-233
elapsedTradingDays, 31-235
element-by-element conformability, 11-1,
14-5
element-by-element operators, 11-1
else, 31-402
elseif, 31-402
empty matrix, 10-15, 31-121, 31-475,
31-496, 31-734, 31-747
end of file, 31-239
end, 31-235
endp, 12-2, 12-5, 31-236
endwind, 31-237
envget, 31-238
environment, search, 31-238
eof, 31-239
eq, 11-11
.eq, 11-12
eqSolve, 31-240
eqSolvemt, 31-244
eqSolvemtControlCreate, 31-248
eqSolvemtOutCreate, 31-248
eqSolveSet, 31-249
eqv, 11-14, 11-15
Index
exponential function, 31-273
exponentiation, 11-6
expression, 10-1
expression, evaluation order, 10-30
expression, scalar, 10-32
extern (dataloop), 31-273
external, 31-274
extraneous spaces, 10-39
eye, 31-276
F
F distribution, 31-78, 31-80
factorial, 11-6
FALSE, 10-32
fcheckerr, 31-277
fclearerr, 31-277
feq, 31-278
feqmt, 31-280
fflush, 31-281
fft, 31-282
fft, 31-282
ffti, 31-283
fftm, 31-284
fftmi, 31-286
fftn, 31-289
fge, 31-278
fgemt, 31-280
fgets, 31-290
fgetsa, 31-291
fgetsat, 31-292
fgetst, 31-293
fgt, 31-278
fgtmt, 31-280
file formats, 20-14
file handle, 31-149, 31-568
fileinfo, 31-293
files, 20-3
Index-8
files, binary, 20-15
files, matrix, 20-13
files, string, 20-16
filesa, 31-295
finance functions, 30-20
fle, 31-278
flemt, 31-280
floor, 31-296
flow control, 10-32
flt, 31-278
fltmt, 31-280
fmod, 31-297
fn, 31-297
fne, 31-278
fnemt, 31-280
fonts, 0-1, 31-298
fonts, 31-298
fopen, 31-299
for, 31-300
Foreign Language Interface, 21-1
format, 31-302
formatcv, 31-309
formatnv, 31-310
forward reference, 18-2
Fourier transform, 31-282
Fourier transform, discrete, 31-190, 31-191
fourier transforms, 30-10
fputs, 31-311
fputst, 31-312
fseek, 31-313
fstrerror, 31-314
ftell, 31-315
ftocv, 31-316
ftos, 31-317
ftostrC, 31-320
function, 10-37, 31-448, 31-609
functions, 30-43
Index
fuzzy conditional functions, 30-12
G
Index-9
Index
gamma function, 31-322
gamma, 31-322
gamma, incomplete, 31-81
gamma, log, 31-490
gammaii, 31-322
GAUSS Data Archives, 20-11, 20-24, 30-32
GAUSS Source Browser, 8-1
Gauss-Legendre quadrature, 31-429
gausset, 29-6, 31-323
gdaAppend, 31-323
gdaCreate, 31-325
gdaDStat, 31-326
gdaDStatMat, 31-328
gdaGetIndex, 31-331
gdaGetName, 31-332
gdaGetNames, 31-332
gdaGetOrders, 31-333
gdaGetType, 31-334
gdaGetTypes, 31-335
gdaGetVarInfo, 31-336
gdaIsCplx, 31-337
gdaLoad, 31-338
gdaPack, 31-341
gdaRead, 31-342
gdaReadByIndex, 31-343
gdaReadSome, 31-343
gdaReadSparse, 31-345
gdaReadStruct, 31-346
gdaReportVarInfo, 31-347
gdaSave, 31-348
gdaUpdate, 31-350
gdaUpdateAndPack, 31-352
gdaVars, 31-353
gdaWrite, 31-354
gdaWrite32, 31-355
gdaWriteSome, 31-356
ge, 11-11
.ge, 11-12
generalized inverse, 31-440, 31-585, 31-586
getarray, 31-358
getArray, 15-12
getdims, 31-359
getDims, 15-27
getf, 31-360
getmatrix, 31-361
getMatrix, 15-13
getmatrix4D, 31-362
getMatrix4D, 15-13
getname, 31-363
getnamef, 31-364
getNextTradingDay, 31-365
getNextWeekDay, 31-366
getnr, 31-366
getnrmt, 31-367
getOrders, 15-27
getorders, 31-368
getpath, 31-368
getPreviousTradingDay, 31-369
getPreviousWeekDay, 31-370
getRow, 31-370
getScalar3D, 15-14
getscalar3D, 31-371
getScalar4D, 15-14
getscalar4D, 31-372
getTrRow, 31-373
getwind, 31-373
global control variables, 29-5
global variable, 12-3
Goertzel algorithm, 31-190
gosub, 31-374
goto, 31-377
Index
gradient, 31-380
gradMT, 31-378
gradMTm, 31-379
gradp, 31-380
graphic panels, 24-7
graphic panels, nontransparent, 24-8
graphic panels, overlapping, 24-7
graphic panels, tiled, 24-7
graphic panels, transparent, 24-8
graphics, publication quality, 24-1
graphprt, 31-382
graphset, 31-384
grid, 24-21
grid subdivisions, 24-21
gt, 11-11
.gt, 11-13
H
hard delimited, 26-6
hasimag, 31-385
hat operator, 11-6, 11-19
header, 31-386
headermt, 31-387
help, 9-1
help facility, 31-482
hermitian matrix, 31-232
hess, 31-388
Hessian, 31-397
hessMT, 31-389
hessMTg, 31-390
hessMTgw, 31-391
hessMTm, 31-393
hessMTmw, 31-394
hessMTw, 31-395
hessp, 31-397
hidden lines, 24-27
hist, 31-398
Index-10
histf, 31-399
histogram, 31-398, 31-399
histp, 31-400
horizontal direct product, 11-7
hsec, 31-401
hyperbolic cosine, 31-142
hyperbolic sine, 31-770
hyperbolic tangent, 31-863
I
if, 31-402
imag, 31-403
imaginary matrix, 31-403
inch coordinates, 24-6
#include, 31-404
incomplete beta function, 31-67
incomplete gamma function, 31-81
indcv, 31-405
indefinite, 10-28
index variables, 31-567
indexcat, 31-406
indexing matrices, 10-41, 11-17
indexing procedures, 11-17
indexing, array, 14-3
indexing, structure, 16-5
indices, 31-408
indices2, 31-409
indicesf, 31-410
indicesfn, 31-411
indnv, 31-412
indsav, 31-413
infinity, 10-28
initialize, 12-4
initializing arrays, 15-1
inner product, 11-5
input, ATOG command, 26-4
input, console, 31-128
Index
isden, 31-442
isinfnanmiss, 31-443
ismiss, 31-443
J
Index
input, keyboard, 31-128
installation, 2-1
installation, UNIX/Linux, 2-1
installation, Windows, 2-2
instruction pointer, 10-3
integration, 30-3, 30-4, 31-418, 31-421,
31-423, 31-426, 31-429, 31-437
interactive commands, 3-2
interpreter, 10-1
intersection, 31-436
intgrat2, 31-414
intgrat3, 31-416
inthp1, 31-418
inthp2, 31-420
inthp3, 31-423
inthp4, 31-426
inthpControlCreate, 31-429
intquad1, 31-429
intquad2, 31-431
intquad3, 31-432
intrinsic function, 10-8
intrleav, 31-434
intrleavsa, 31-435
intrsect, 31-436
intrsectsa, 31-437
intsimp, 31-437
inv, 31-438
invar, ATOG command, 26-5
inverse cosine, 31-29
inverse sine, 31-30
inverse, generalized, 31-440, 31-585, 31-586
inverse, matrix, 31-438
inverse, sweep, 31-440
invpd, 31-438
invswp, 31-440
iscplx, 31-441
iscplxf, 31-442
Jacobian, 31-380
K
keep (dataloop), 31-444
key, 31-445
keyav, 31-447
keyboard input, 31-132
keyboard, reading, 31-445
keys, command, 5-17
keys, edit, 5-16
keys, function, 5-18
keys, menu, 5-19
keys, movement, 5-15
keys, text selection, 5-17
keystroke macros, 5-2
keyw, 31-447
keyword, 12-1, 12-7
keyword procedure, 31-448
keyword, 31-448
keywords, 30-43
Kronecker, 11-6
L
label, 10-36, 10-39, 12-1, 31-374, 31-377
lag (dataloop), 31-449
lag1, 31-450
lagn, 31-450
lambda, 31-77
lapeighb, 31-451
lapeighi, 31-452
lapeigvb, 31-453
Index-11
Index
lapeigvi, 31-455
lapgeig, 31-456
lapgeigh, 31-457
lapgeighv, 31-458
lapgeigv, 31-459
lapgschur, 31-468
lapgsvdcst, 31-460
lapgsvds, 31-463
lapgsvdst, 31-465
lapsvdcusv, 31-469
lapsvds, 31-471
lapsvdusv, 31-472
le, 11-10
.le, 11-12
least squares, 11-5
least squares regression, 31-551, 31-556
left-hand side, 18-2
legend, 24-22
let, 31-473
lib, 31-478
libraries, 18-1, 30-44
libraries, active, 31-480
Library Tool, 7-1
library, 31-479
line numbers, 31-482
line thickness, 24-16, 24-20, 24-25
line type, 24-25
linear algebra, 30-4
linear equation, 31-772
linear equation solution, 11-5
lines, 24-21, 24-22, 24-24
#linesoff, 31-482
#lineson, 31-482
linsolve, 31-483
listwise (dataloop), 31-484
listwise deletion, 31-211, 31-213, 31-581
literal, 10-23, 11-19
Index-12
ln, 31-484
lncdfbvn, 31-485
lncdfbvn2, 31-486
lncdfmvn, 31-488
lncdfn, 31-488
lncdfn.src, 31-83, 31-96
lncdfn2, 31-489
lncdfnc, 31-490
lnfact, 31-490
lnpdfmvn, 31-491
lnpdfmvt, 31-492
lnpdfn, 31-493
lnpdft, 31-493
load, 31-494
loadarray, 31-499
loadd, 31-501
loadf, 31-494
loadk, 31-494
loadm, 31-494
loadp, 31-494
loads, 31-494
loadstruct, 31-502
loadwind, 31-502
local variable declaration, 12-3
local variables, 10-8, 12-3, 31-503
local, 12-2, 31-503
locate, 31-504
loess, 31-504
loessmt, 31-505
loessmtControlCreate, 31-506
log coordinates, 31-508
log factorial, 31-490
log gamma, 31-490
log, 31-507
log, base 10, 31-507
log, natural, 31-484
logging commands, 31-124
Index
M
machEpsilon, 31-515
machine epsilon, 31-93, 31-855, 31-860
machine requirements, 2-2
macros, 5-2
magnification, 24-29
make (dataloop), 31-516
makevars, 31-516
makewind, 31-518
margin, 31-519
matalloc, 31-520
matinit, 31-521
matrices, indexing, 10-41
matrix conformability, 11-1
Matrix Editor, 6-1
matrix files, 20-13
matrix manipulation, 30-22
matrix, creation, 31-473
matrix, empty, 10-15, 31-121, 31-475,
31-496, 31-734, 31-747
matrix, ones, 31-565
matrix, zeros, 31-932
mattoarray, 15-28, 31-521
maxbytes, 31-526
maxc, 31-522
maximizing performance, 28-1
maximum element, 31-522
maximum element index, 31-523
maxindc, 31-523
maxv, 31-524
mbesseli, 31-527
mean, 31-530
meanc, 31-530
median, 31-530
memory, 31-181
memory, clear all, 31-545
menus, 4-1
mergeby, 31-531
mergevar, 31-532
merging, 30-38
minc, 31-533
minimum element, 31-533
minimum element index, 31-534
minindc, 31-534
minv, 31-538
miss, 31-535
missex, 31-537
missing character, 31-544
missing values, 11-5, 31-211, 31-212,
31-443, 31-535, 31-537, 31-544,
31-581, 31-749
missrv, 31-535
modulo division, 11-5
moment matrix, 31-554, 31-559
momentd, 31-541
Index-13
Index
logical operators, 11-13
loglog, 31-508
logx, 31-508
logy, 31-509
looping, 10-32, 30-41, 31-197
looping with arrays, 15-17
loopnextindex, 15-19, 31-510
lower triangular matrix, 31-512
lower, 31-511
lowmat, 31-512
lowmat1, 31-512
lt, 11-10
.lt, 11-12
ltrisol, 31-513
LU decomposition, 11-5, 31-514
lu, 31-514
lusol, 31-515
Index
Moore-Penrose pseudo-inverse, 31-585,
31-586
movingave, 31-542
movingaveExpwgt, 31-543
movingaveWgt, 31-544
msym, 31-544
msym, ATOG command, 26-10
multiplication, 11-5
multiplicative sequence, 31-756
N
N-dimensional arrays, 14-1, 15-1, 30-27
NaN, 10-28
NaN, testing for, 10-29, 11-9
ne, 11-11
.ne, 11-12
new, 31-545
nextindex, 31-546
nextn, 31-547
nextnevn, 31-547
nextwind, 31-548
nocheck, 26-10
Normal distribution, 31-83, 31-85, 31-86,
31-87, 31-89, 31-91, 31-93, 31-95,
31-485, 31-488, 31-489, 31-490
Normal distribution, bivariate, 31-69
not, 11-13, 11-14
.not, 11-15
null space, 31-549
null, 31-549
null1, 31-550
numCombinations, 31-551
O
obsolete commands, 0-1
ols, 31-551
Index-14
olsmt, 31-556
olsmtControlCreate, 31-562
olsqr, 31-562
olsqr2, 31-563
olsqrmt, 31-564
ones, 31-565
open, 31-566
operators, 10-1, 11-4
operators, element-by-element, 11-1
optimization, 30-16
optn, 31-571
optnevn, 31-571
or, 11-14, 11-15
.or, 11-15
orth, 31-573
orthogonal complement, 31-549
orthonormal, 31-549, 31-573
outer product, 11-6
output, 20-4
output functions, 30-52
output, 31-574
output, ATOG command, 26-10
outtyp (dataloop), 31-577
outtyp, ATOG command, 26-11
outvar, ATOG command, 26-11
outwidth, 31-577
P
pacf, 31-578
packed ASCII, 26-1, 26-8
packedToSp, 31-579
packr, 31-581
_pageshf, 24-14
_pagesiz, 24-14
pairwise deletion, 11-5, 31-211, 31-213
panel data, 15-32
_parrow, 24-14
Index
_pnumht, 24-27
pointer, 11-17, 12-10, 12-11, 31-503
pointer, instruction, 10-3
pointers, structure, 16-9
polar, 31-587
polychar, 31-587
polyeval, 31-588
polyint, 31-589
polymake, 31-590
polymat, 31-591
polymroot, 31-591
polymult, 31-593
polynomial, 31-590
polynomial interpolation, 31-589
polynomial operations, 30-9
polynomial regression, 31-591
polynomial, characteristic, 31-587
polynomial, evaluation, 31-588
polynomial, roots, 31-594
polyroot, 31-594
pop, 31-594
pqgwin, 31-595
precedence, 10-30
precision control, 30-20
predicted values, 31-563
preferences, 5-10
preservecase, 26-12
previousindex, 31-596
princomp, 31-597
print, 31-598
printdos, 31-604
printfm, 31-605
printfmt, 31-608
probability density function, Normal, 31-583
proc, 12-2, 31-609
procedure, 12-1, 31-503, 31-609
procedure, definitions, 10-3, 12-2
Index-15
Index
_parrow3, 24-16
parse, 31-582
pause, 31-583
_paxes, 24-17
_paxht, 24-17
_pbartyp, 24-17
_pbarwid, 24-18
_pbox, 24-18
_pboxlim, 24-19
_pcolor, 24-19
_pcrop, 24-19
_pcross, 24-19
_pdate, 24-20
pdfn, 31-583
_perrbar, 24-20
_pframe, 24-20
_pgrid, 24-21
pi, 31-584
pinv, 31-585
pinvmt, 31-586
pixel coordinates, 24-6
_plctrl, 24-21
_plegctl, 24-22
_plegstr, 24-22
_plev, 24-22
_pline, 24-22
_pline3d, 24-24
plot coordinates, 24-6
_plotshf, 24-24
_plotsiz, 24-25
_pltype, 24-25
_plwidth, 24-25
_pmcolor, 24-25
_pmsgctl, 24-26
_pmsgstr, 24-26
_pnotify, 24-26
_pnum, 24-26
Index
procedures, 30-43
procedures, indexing, 12-10
procedures, multiple returns, 12-11
procedures, passing to other procedures, 12-9
prodc, 31-610
products, 31-611
Profiler, 23-1
program, 10-4
program control, 30-40
program space, 31-766
program, run, 31-736
properties, editor, 5-2
_protate, 24-27
_pscreen, 24-27
pseudo-inverse, 31-585, 31-586
_psilent, 24-27
_pstype, 24-27
_psurf, 24-27
_psym, 24-28
_psym3d, 24-28
_psymsiz, 24-28
_ptek, 24-28
_pticout, 24-28
_ptitlht, 24-28
Publication Quality Graphics, 24-1, 30-54
putArray, 15-15
putarray, 31-611
putf, 31-612
putvals, 31-614
PV structure, 16-15, 17-1
pvCreate, 31-615
_pversno, 24-29
pvGetIndex, 31-615
pvGetParNames, 31-616
pvGetParVector, 31-617
pvLength, 31-618
pvList, 31-619
Index-16
pvPack, 31-619
pvPacki, 31-620
pvPackm, 31-621
pvPackmi, 31-623
pvPacks, 31-624
pvPacksi, 31-625
pvPacksm, 31-627
pvPacksmi, 31-629
pvPutParVector, 31-631
pvTest, 31-632
pvUnpack, 31-633
_pxpmax, 24-29
_pxsci, 24-29
_pypmax, 24-29
_pysci, 24-29
_pzclr, 24-29
_pzoom, 24-29
_pzpmax, 24-29
_pzsci, 24-29
Q
QNewton, 31-633
QNewtonmt, 31-636
QNewtonmtControlCreate, 31-641
QNewtonmtOutCreate, 31-641
QNewtonSet, 31-642
QProg, 31-642
QProgmt, 31-644
QProgmtInCreate, 31-646
qqr, 31-646
qqre, 31-648
qqrep, 31-651
QR decomposition, 31-562, 31-564
qr, 31-653
qre, 31-654
qrep, 31-657
qrsol, 31-659
Index
R
radii, 24-22
random numbers, 30-10
rank of a matrix, 31-676
rank, 31-676
rankindx, 31-677
readr, 31-678
real, 31-679
recode (dataloop), 31-682
recode, 31-680
recserar, 31-683
recsercp, 31-685
recserrc, 31-686
recursion, 12-5
reduced row echelon form, 31-735
regression, 31-551, 31-556
relational operator, dot, 11-11, 11-21
relational operators, 11-9
relative error, 31-93, 31-98
rerun, 31-687
reserved words, 0-1
reshape, 31-688
residuals, 31-553, 31-557, 31-563
retp, 12-2, 12-5, 31-689
return, 31-690
rev, 31-690
rfft, 31-691
rffti, 31-692
rfftip, 31-693
rfftn, 31-694
rfftnp, 31-695
rfftp, 31-697
right-hand side, 18-2
rndbeta, 31-698
rndcon, 31-699
rndgam, 31-701
rndi, 31-702
rndKMbeta, 31-703
rndKMgam, 31-704
rndKMi, 31-706
rndKMn, 31-707
rndKMnb, 31-709
rndKMp, 31-710
rndKMu, 31-711
rndKMvm, 31-713
rndLCbeta, 31-714
rndLCgam, 31-715
rndLCi, 31-717
rndLCn, 31-719
rndLCnb, 31-721
rndLCp, 31-723
rndLCu, 31-724
rndLCvm, 31-726
rndmult, 31-699
rndn, 31-728
rndnb, 31-729
rndp, 31-730
rndseed, 31-699
rndu, 31-730
rndvm, 31-732
rotater, 31-732
round down, 31-296
round up, 31-103
Index
qrtsol, 31-660
qtyr, 31-660
qtyre, 31-663
qtyrep, 31-666
quadrature, 31-429
quantile, 31-668
quantiled, 31-669
qyr, 31-671
qyre, 31-672
qyrep, 31-674
Index-17
Index
round, 31-733
rows, 31-734
rowsf, 31-735
rref, 31-735
rules of syntax, 10-38
run options, 5-11
run, 31-736
Run-Time Library structures, 17-1
running commands, 5-4
running programs, 5-5
S
satostrC, 31-738
save, 31-739
saveall, 31-741
saved, 31-742
savestruct, 31-743
savewind, 31-744
saving the workspace, 19-2
scalar error code, 31-251, 31-746
scalar expression, 10-32
scale, 31-744
scale3d, 31-745
scalerr, 31-746
scalinfnanmiss, 31-748
scaling, 31-744, 31-745
scalmiss, 31-749
schtoc, 31-750
schur, 31-751
scientific functions, 30-1
screen, 31-752
searchsourcepath, 31-753
secondary section, 10-5
seekr, 31-754
select (dataloop), 31-755
selif, 31-755
semicolon, 10-2
Index-18
seqa, 31-756
seqm, 31-756
sequence function, 31-756
sequence functions, 30-19
series functions, 30-19
set difference function, 31-759
setArray, 15-16
setarray, 31-758
setdif, 31-759
setdifsa, 31-760
setvars, 31-761
setvwrmode, 31-762
setwind, 31-762
shell, 31-763
shiftr, 31-764
show, 31-765
Simpson’s method, 31-437
sin, 31-768
sine, inverse, 31-30
singleindex, 31-769
singular value decomposition, 31-841,
31-842, 31-843, 31-845
singular values, 31-840, 31-844
singularity tolerance, 0-1
sinh, 31-770
sleep, 31-771
soft delimited, 26-5
solpd, 31-772
sort data file, 31-775
sort index, 31-777
sort, heap sort, 31-776
sort, multiple columns, 31-778
sort, quicksort, 31-774
sortc, 31-774
sortcc, 31-774
sortd, 31-775
sorthc, 31-776
Index
square root, 31-811
src_path, 18-1
standard deviation, 31-38, 31-40, 31-212,
31-213, 31-812, 31-813
standard deviation of residual, 31-554,
31-560
standard errors, 31-554, 31-560
statement, 10-2, 10-38
statement, executable, 10-3
statement, nonexecutable, 10-3
statistical distributions, 30-17
statistical functions, 30-13
statistics, descriptive, 31-210, 31-212
status bar, 4-14
stdc, 31-812
stdsc, 31-813
Stirling’s formula, 31-491
stocv, 31-814
stof, 31-814
stop, 31-815
strcombine, 31-815
strindx, 31-816
string array concatenation, 11-19
string arrays, 10-24, 10-25
string concatenation, 11-18
string files, 20-16
string handling, 30-47
string index, 31-816, 31-819
string length, 31-817
string, long, 10-38
string, substring, 31-820
strings, graphics, 24-26
strlen, 31-817
strput, 31-818
strrindx, 31-819
strsect, 31-820
strsplit, 31-821
Index-19
Index
sorthcc, 31-776
sortind, 31-777
sortindc, 31-777
sorting, 30-38
sortmc, 31-778
sortr, sortrc, 31-779
Source Browser, 8-1
spaces, 11-17
spaces, extraneous, 10-39, 11-17
sparse matrices, 30-26
spCreate, 31-780
spDenseSubmat, 31-781
spDiagRvMat, 31-782
spEye, 31-784
spGetNZE, 31-785
spline, 31-786
spNumNZE, 31-787
spOnes, 31-788
SpreadsheetReadM, 31-789
SpreadsheetReadSA, 31-790
spreadsheets, 30-30
SpreadsheetWrite, 31-790
spScale, 31-791
spSubmat, 31-792
spToDense, 31-793
spTrTDense, 31-794
spTScalar, 31-795
spZeros, 31-796
sqpSolve, 31-797
sqpSolvemt, 16-22
sqpSolveMT, 31-801
sqpSolvemtControl structure, 16-24
sqpSolveMTControlCreate, 31-809
sqpSolveMTlagrangeCreate, 31-809
sqpSolveMToutCreate, 31-810
sqpSolveSet, 31-810
sqrt, 31-811
Index
strsplitPad, 31-822
strtodt, 31-823
strtof, 31-825
strtofcplx, 31-825
strtriml, 31-826
strtrimr, 31-826
strtrunc, 31-827
strtruncl, 31-827
strtruncpad, 31-828
strtruncr, 31-828
structure definition, 16-1
structure indexing, 16-5
structure instance, 16-2
structure pointers, 16-9
structure, DS, 16-14, 17-7
structure, PV, 16-15, 17-1
structures, 16-1, 30-29
structures, arrays of, 16-4
structures, control, 16-21
submat, 31-829
submatrix, 31-829
subroutine, 10-37, 31-374
subroutines, 30-42
subsample, 31-270
subscat, 31-830
substitution, 11-19
substring, 31-820
substute, 31-831
subvec, 31-833
sum, 31-834
sumc, 31-834
sumr, 31-836
surface, 31-838
svd, 31-840
svd1, 31-841
svd2, 31-842
svdcusv, 31-843
Index-20
svds, 31-844
svdusv, 31-845
sweep inverse, 31-440
symbol names, 10-39
symbol table, 31-765
symbol table type, 31-880
symbols, allocate maximum number, 31-545
syntax, 10-38
sysstate, 31-846
system, 31-861
T
t distribution, Student’s, 31-97
tab, 31-861
table, 11-6
tan, 31-862
tanh, 31-863
tempname, 31-864
tensor, 11-6
text files, 30-31
TGAUSS, 3-1
thickness, line, 24-16, 24-20, 24-25
tick marks, 24-28
tilde, 11-9
time and date functions, 30-50
time, 25-2, 31-865
time, elapsed, 31-253
timed iterations, 25-6
timedt, 31-865
timestr, 31-866
timeutc, 31-867
timing functions, 31-401
title, 31-867
tkf2eps, 31-868
tkf2ps, 31-869
tocart, 31-869
todaydt, 31-870
Index
U
unconditional branching, 10-36
underdetermined, 31-554, 31-559
union, 31-884
unionsa, 31-884
uniqindx, 31-885
uniqindxsa, 31-886
unique, 31-887
uniquesa, 31-888
until, 31-197
upmat, 31-889
upmat1, 31-889
upper triangular matrix, 31-889
upper, 31-890
use, 31-891
user-defined function, 31-448, 31-609
utctodt, 31-892
utctodtv, 31-893
utrisol, 31-894
V
vals, 31-895
varget, 31-896
vargetl, 31-897
variable names, 31-363, 31-364
variance, 31-211, 31-213
variance-covariance matrix, 31-554, 31-559,
31-903, 31-904
varindxi, 31-567
varmall, 31-898
varmares, 31-899
varput, 31-900
varputl, 31-901
vartypef, 31-903
vcm, 31-903
vcms, 31-904
vcx, 31-903
vcxs, 31-904
vec, vecr, 31-905
vech, 31-906
vector (dataloop), 31-907
vectors, 10-41
vget, 31-908
view, 31-908
viewing graphics, 3-2
viewing variables, 6-2
viewxyz, 31-909
Index-21
Index
Toeplitz matrix, 31-870
toeplitz, 31-870
token, 31-871
toolbars, 4-10
topolar, 31-872
trace program execution, 31-873
trace, 31-873
translation phase, 22-3
transpose, 11-8
transpose, bookkeeping, 11-8
trap flag, 31-875, 31-877
trap state, 31-747
trap, 31-874
trapchk, 31-877
triangular matrix, lower, 31-512
triangular matrix, upper, 31-889
trigamma, 31-878
trimr, 31-879
trivariate Normal, 31-100
troubleshooting, libraries, 18-12
TRUE, 10-32, 11-10
trunc, 31-880
truncating, 31-880
type, 31-880
typecv, 31-881
typef, 31-883
Index
vlist, 31-910
vnamecv, 31-910
volume, 31-911
vput, 31-911
vread, 31-912
vtypecv, 31-912
W
wait, 31-913
waitc, 31-913
walkindex, 31-913
watch variables, 6-2
watch window, 5-10
weighted count, 31-145
while, 31-197
window, 20-4
window, 31-915
window, clear, 31-117
workbox, 31-909, 31-911
workspace, 31-181, 31-766
writer, 31-915
X
xlabel, 31-917
xlsGetSheetCount, 31-918
xlsGetSheetSize, 31-918
xlsGetSheetTypes, 31-919
xlsMakeRange, 31-920
xlsreadm, 31-921
xlsreadsa, 31-922
xlsWrite, 31-924
xlsWritem, 31-925
xlswritesa, 31-926
xor, 11-14, 11-15
.xor, 11-15
xpnd, 31-927
Index-22
xtics, 31-929
xy, 31-930
xyz, 31-930
Y
ylabel, 31-931
ytics, 31-931
Z
zeros, 31-932
zlabel, 31-933
zooming graphs, 24-29
ztics, 31-933