Documentation Centre (v14.0)

Core Documentation

These documents describe the details of the language and program construction; they are not specific to an operating system.

Dyalog Language Reference Guide

This document details the individual elements that form the 'vocabulary' of the APL language. It explains every primitive function, primitive operator, system function, system variable, system command and error message in Dyalog.

It is assumed that the reader has a reasonable understanding of mathematics.

Dyalog Programmer's Reference Guide

This document details the syntax that forms the 'grammar' of the APL language. It describes the viable values that can be used in expressions and explains how the individual language elements can be manipulated through defined functions and operators, control structures and object oriented programming, as well as the way in which multi-threading can be implemented.

It is assumed that the reader has a reasonable understanding of mathematics.

Dyalog User Guide

This document introduces the Dyalog user interface. It describes the windows, menu options, built-in tools and customisation possibilities that are available when running Dyalog on the Microsoft Windows operating system and explains the programming techniques, file storage mechanisms, integrity checking features and error trapping concepts available with Dyalog.

It is assumed that the reader has a basic understanding of software terminology.

Dyalog Object Reference Guide

This document describes the complete set of objects, properties, events and methods through which Dyalog supports the creation of a Graphical User Interface. This document should be read in conjunction with the Dyalog Interface Guide.

Dyalog Interface Guide

This document describes various interfaces between Dyalog and Microsoft Windows, including the Multiple Document Interface (MDI) and docking, the Component Object Model (COM) interface and other Microsoft Windows applications. It also describes the underlying concepts, implementation rules and graphical resources available when creating a user interface using Dyalog. This document should be read in conjunction with the Dyalog Object Reference Guide.

Dyalog Experimental Functionality – Compiler

This document describes the compiler, introduced with Dyalog version 14.0 for the purpose of improving the performance of certain defined functions and operators, and details the syntax and restrictions of the current implementation.

NOTE: The functionality and behaviour of the compiler has not yet been finalised and is subject to change by Dyalog Ltd at any time.

Dyalog Experimental Functionality – Parallel Language Features

This document describes proposals for two new primitives, the function isolate and the monadic operator parallel, and a new type of array known as a future. These are designed to allow APL developers to take advantage of multiple processors to execute code in parallel.

NOTE: Although version 14.0 only provides a model, the design is very close to being complete. All users with applications containing potential parallelism are encouraged to make use of this experimental implementation to help confirm the design and reveal any weaknesses that need to be worked on in the final implementation as part of the core language.

Microsoft Windows-Specific Documentation

These documents are specific to running Dyalog on the Microsoft Windows operating system.

Dyalog for Microsoft Windows

Installation and Configuration Guide

This document covers the installation procedure and configuration options for Dyalog on the Microsoft Windows operating system. It details the parameters that can be used to customise individual instances, the creation of executables and run-time applications, use of the command line and the Dyalog Dynamic Link Library, as well as describing the recovery process if a system error is encountered.

It is assumed that the reader has a basic knowledge of Microsoft Windows and software terminology; a working knowledge of Dyalog is useful but not essential.

Dyalog for Microsoft Windows

.NET Framework Interface Guide

This document describes the Dyalog interface to the Microsoft .NET Framework. The information provided in this document does not explain the features of the .NET Framework but concentrates on explaining the APL interfaces that sit between the .NET Framework and the APL Session.

It is assumed that the reader is familiar with the .NET Framework and has a basic understanding of OO methodologies.

UNIX-Specific Documentation

These documents are specific to running Dyalog on various UNIX platforms, for example, AIX or Linux distributions.

Dyalog for UNIX

Installation and Configuration Guide

This document covers the installation procedure and configuration options for Dyalog on a UNIX platform. It details the environment variables that can be used to customise individual instances, the requirements for using the PuTTY terminal emulator and the upgrade and uninstall procedures.

It is assumed that the reader has a basic knowledge of UNIX and software terminology; a working knowledge of Dyalog is useful but not essential.

Dyalog for UNIX

User Guide

This document describes the different input windows available and the keystrokes that can be used within them, how commands can be entered and the (configurable) keycode-keystroke mappings.

It is assumed that the reader has a basic knowledge of UNIX and a working knowledge of Dyalog.

Dyalog for Raspberry Pi User Guide

This document is intended for anyone who wants to run Dyalog on a Raspberry Pi. The information provided in this document supplements that given in the Dyalog for UNIX Installation and Configuration Guide and the Dyalog for UNIX User Guide. In cases where the information given is different between these documents, this document should be regarded as the definitive source for Dyalog on the Raspberry Pi.

It is assumed that the reader has a basic understanding of Linux on the Raspberry Pi. No prior knowledge of Dyalog is required.

Tools Documentation

The tools described by these documents can be used to supplement Dyalog's core functionality; they can enable a developer to produce code more efficiently, provide an interface to other software/platforms, or be integrated and deployed in an application.

Dyalog Conga Reference Guide

This document is a complete guide to Conga, Dyalog’s framework for TCP/IP communications. It describes the tools with which Conga can be used to create a variety of clients and servers using protocols based on TCP/IP, including HTTP, HTTPS, FTP, Telnet and SMTP. It covers Conga support for secure communications (using SSL/TLS) and communication between APL processes (allowing them to exchange native APL data directly). It also introduces the Conga workspace, which includes a comprehensive collection of samples showing the implementation of various types of servers and clients, and contains a technical reference of the namespaces, classes and functions provided with Conga.

It is assumed that the reader has a reasonable understanding server-client connection protocols; a working knowledge of HTTP/FTP/SMTP is needed to understand the samples provided with the Conga workspace.

Dyalog MiServer Reference Guide

This document is a complete guide to MiServer, an APL open source web server that brings the power of APL to the web. It takes a user through the complete webpage creation process, from installation and configuration of MiServer to interacting with a completed website. In addition it covers customising the look and functionality of your website through the use of cascading style sheets (CSS) and a variety of JavaScript/jQuery-based widgets. It also provides examples to use as the basis for a new website and contains a technical reference of the namespaces, classes and functions provided with MiServer.

A working knowledge of HTML is useful but not essential.

Dyalog NewLeaf Reference Guide

This document is a complete guide to NewLeaf, the frame-based publishing tool that enables high-quality printed output to be generated from simple APL arrays. It details the Designer user interface, syntax and page design elements that combine to allow complete customisation of the output and includes a tutorial that walks through the process of constructing progressively more sophisticated tables. It also explains the namespaces, objects and properties supplied with the NewLeaf workspace.

Dyalog PEACH Reference Guide

This document is a complete guide to the parallel workspace, which enables Dyalog application programmers to make use of multiple cores on one or more computers. It uses examples to show how performance can be enhanced, covers the way in which slave processes can be created and managed and describes the procedure for tuning and debugging within the parallel workspace. It also explains the namespaces, parallel operators and functions provided with the parallel workspace.

Dyalog R Interface Guide

This document is a complete guide to RConnect, the interface between Dyalog and R, the integrated programming language and software environment for statistical computing and graphics. It explains how RConnect makes the R environment an extension of the active APL workspace, enabling APL users to extend APL applications by either utilising existing R skills or acquiring new skills and making use of the large – and rapidly expanding – collection of statistical and analytical packages that are continuously being added to R.

No prior knowledge of R is required.

Dyalog RainPro Reference Guide

NOTE: RainPro has been superseded by SharpPlot; it is still supported and distributed but no new functionality will be added and Dyalog recommends replacing any calls to RainPro with calls to SharpPlot; SharpPlot has a more consistent API, better-quality graphics (alpha blending, anti-aliased raster graphics), superior performance and is multi-platform rather than limited to Microsoft Windows.

Dyalog SALT Reference Guide

This document is a complete guide to SALT – the Simple APL Library Toolkit – and explains its functions, their syntax, modifiers and modifier values.

Dyalog SAWS Reference Guide

This document is a complete guide to SAWS, the Stand-Alone Web Service framework that facilitates the sharing of functionality developed in Dyalog using Web Services and enables the integration of functionality from external Web Services into an APL application. It describes how SAWS can be used to build and run a Web Service that can then be shared over a local network, intranet or the Internet. It also covers the way in which SAWS can be integrated with an application and explains the namespaces, functions and common data structures provided with SAWS.

It is assumed that the reader has a basic knowledge of Web Services.

Dyalog SharpPlot Reference Guide

This document is a complete guide to SharpPlot, the charting software engine that brings true publication-quality graphics to your application. It covers the generation of all the different chart types that can be produced along with the properties and methods that can be used to customise them.

It is assumed that the reader has a reasonable understanding of the .NET bridge.

Dyalog SQAPL Interface Guide

This document is a complete guide to SQAPL, the interface between APL and database drivers that conform to the Microsoft ODBC specification. It describes the way in which SQAPL can be integrated with an application, details the objects and data types supported by SQAPL and explains the functions (both high-level and low-level) provided with SQAPL.

It is assumed that the reader has a reasonable understanding of SQL.

Dyalog User Commands Reference Guide

This document is a complete guide to user commands. It describes how to create and implement new user commands and provides a summary of the user commands supplied with Dyalog.

Dyalog Application Tuning Guide

This document describes the way in which the ⎕PROFILE system function and the associated ]PROFILE user command can be used to obtain a performance profile of an application. It describes both the graphical and textual output that can be obtained following data collection and shows how this data can be analysed and potential inefficiencies identified.

Dyalog Code Libraries Reference Guide

This document describes the workspaces, scripts and DLLs that are supplied with Dyalog.

Dyalog Workspace Transfer Guide

This document describes the steps that are involved in moving code and data, either from a different dialect of APL to Dyalog or from one version of Dyalog to an earlier version. It also provides examples of importing workspaces created in APL2, APLX or APL+Win into Dyalog.

It is assumed that the reader has a reasonable understanding of Dyalog and, if a migration is being performed from another dialect of APL, a reasonable understanding of that dialect of APL.

Cheat Sheets

These short documents comprise brief summaries of some of the terminology, syntax and conventions used in Dyalog.

Binding Strengths

Component Files

Idioms

Nameclasses and Subclasses (⎕NC)

Native Files

Nomenclature: Functions and Operators

SALT Functions: Syntax

Release Notes

These documents cover the changes made to Dyalog and some of its supported tools since the first release of Dyalog version 13.2.

Dyalog version 14.0 Release Notes

This document describes the changes and new features in Dyalog version 14.0 compared with Dyalog version 13.2.

SALT version 2.40 Release Notes

This document describes the changes and new features in SALT version 2.40 (released with the first release of Dyalog version 14.0) compared with SALT version 2.31 (released with the first release of Dyalog version 13.2).

User Commands version 2.00 Release Notes

This document describes the changes and new features in User Commands version 2.00 (released with the first release of Dyalog version 14.0) compared with User Commands version 1.29 (released with the first release of Dyalog version 13.2).

Interactive Documentation

Online documentation

A subset of the documentation – internet access required.

Offline documentation

Offline version of the online documentation.

Miscellaneous

All PDFs (colour)

All documentation PDFs formatted for on-screen viewing.

Printable PDFs (monochrome)

A subset of the documentation PDFs formatted for printing.

Reference Card

A brief summary of the syntax and functionality of some of the core language components (495mm by 210mm).

Printed manuals

Subset of the documentation available to purchase as printed and bound manuals.