Difference between revisions of "VasCalc Documentation - User's Guide"

From Drorbn
Jump to: navigation, search
Line 57: Line 57:
 
Because operations on chord diagrams (such as multiplication and reduction) can often be resource-intensive, it is desirable to work with representations in Java as much as possible. The <code>ASeries</code> object is meant to facilitate this. To create one, use the command <code>ASeries[CDcombo, l, m]</code>, where <code>CDcombo</code> is a linear combination of chord diagrams (represented by <code>CD</code>'s, and possibly a constant term), all of which are on a fixed skeleton of <code>l</code> lines and <code>m</code> circles, and may have a different number of chords. It is important to note that an <code>ASeries</code> carries with it the notion of an order, defined implicitly by the maximum number of chords to appear in a diagram in <code>CDcombo</code>; the result of any and all computations are only given up to the lowest order appearing therein. (Soon to come: option to explicitly specify order).
 
Because operations on chord diagrams (such as multiplication and reduction) can often be resource-intensive, it is desirable to work with representations in Java as much as possible. The <code>ASeries</code> object is meant to facilitate this. To create one, use the command <code>ASeries[CDcombo, l, m]</code>, where <code>CDcombo</code> is a linear combination of chord diagrams (represented by <code>CD</code>'s, and possibly a constant term), all of which are on a fixed skeleton of <code>l</code> lines and <code>m</code> circles, and may have a different number of chords. It is important to note that an <code>ASeries</code> carries with it the notion of an order, defined implicitly by the maximum number of chords to appear in a diagram in <code>CDcombo</code>; the result of any and all computations are only given up to the lowest order appearing therein. (Soon to come: option to explicitly specify order).
  
Operations: +, . , invert (only of form 1 + ...), AddStrand, DoubleStrand, PermuteStrand[{{..},{..}}], Reduce
+
There are several operations one can perform on an <code>ASeries</code> object. Addition and multiplication is achieved using the <code>+</code> and <code>.</code> operators respectively. Also, <code>ASeries</code> objects can be inverted (up to the highest order), provided they are of the form <code>(1 + higher order terms) </code>.
 +
 
 +
Additionally, the following operations are available:
 +
*<code>AddStrand[ASeries, n]</code> adds an empty strand to all the diagrams in the given <code>ASeries</code> after the <code>n</code>'th position.
 +
*<code>DoubleStrand[ASeries, n]</code> doubles the <code>n</code>'th strand in all the diagrams in the given <code>ASeries</code>.
 +
*<code>PermuteStrand[ASeries, perm]</code> applies the permutation <code>perm</code> to the strands of the chord diagrams in the given <code>ASeries</code>. The permutation is to be represented as a list of cycles.
 +
All these operations will be demonstrated in the next section.
 +
 
 +
Finally, to convert an <code>ASeries</code> back to a human-readable form, use the command: <code>CD[ AS ]</code>, where <code>AS</code> is the object to be converted.
  
CD[AS_ASeries] converts back.
 
  
  

Revision as of 14:23, 29 July 2006

This page documents the ChordsMod4T component of the VasCalc project. This page is also under construction.

Contents

Overview

This package provides a Mathematica interface to work with the space generated by chord diagrams on a fixed skeleton of lines and circles, modulo the 4-T relation. See Dror Bar-Natan's Survey of Finite Type Invariants for further details.

Requirements

The software requirements of this package are Mathematica 4.1 and Java 1.4 (or greater, in both cases). However, note that default installations of Mathematica 4.1 and up include a Java runtime binary, and require no further configuration for this package to work.

While there are no specific hardware requirements, the computations involved are rather resource-intensive. Users of low-end machines will see a smaller range of parameters for which the computation is practicable. We'll have an expected performance profile once work on this package is done.

Installation

If you have an up-to-date copy of the repository, skip ahead. If not, download ChordsMod4T.tar.gz and extract it to a directory of your choice.

You must also ensure that there is a directory named "CM4TData" under the installation directory, creating it if neccessary. This is for save/load functionality to work properly.

Usage

Initialization

In a Mathematica session, load the definitions by typing:

In[1]:= <</path_to_install_folder/CDinterface.m

where "path_to_install_folder" is either the "trunk" folder of the repository, or the folder in which the above archive, if downloaded, was unpacked.

You must also issue the following command, to inform Mathematica of the location of the required Java objects:

In[2]:= SetVasCalcPath["/path_to_install_folder"];

These steps must be followed at the start of each Mathematica session you wish to use this package.

Representing Chord Diagrams

Our convention for representing a chord diagram in Mathematica is through a CD object containing Line and Circle expressions as per the skeleton. To construct such a representation,

  • Number the chords on the diagram.
  • For each line on the skeleton, put within the brackets of its Line expression the numbers of the chords that have their endpoints on that line, starting from the bottom and working up. For each circle, do the same, but one can choose an arbitrary starting point and count around. If there are no chords on a given line or circle, leave the brackets empty, as in Line[].

Naturally, there are many representations for a given diagram. This package also allows for formal linear combinations of CD objects.

Computing chord diagram spaces modulo 4T relations

The object CDSpace[l,m,n] represents the rational vector space generated by chord diagrams with n chords on a skeleton with l lines and m circles, modulo the 4-T relation. The first time a space is encountered in a session, a check is made to see if there is data for the required space on disc (under the path_to_install_folder/CM4TData directory). If no such entry exists, the space is computed, and by default the results are saved on disc for future use - this computation may be substantial, depending on the values of the parameters. One can prevent the saving of data by using the command CDSpace[l,m,n, WriteToDisc -> False] .

One can obtain the dimension of a chord diagram space, as follows:

In[3]:= GetDimension[CDSpace[1,1,3]]
Out[3]= 19


One can also obtain a basis for a chord diagram space (modulo 4T), expressed as a list of chord diagrams:

In[4]:= GetCDBasis[ CDSpace[1,1,3] ]
Out[4]= {CD[Line[1, 1], Circle[2, 2, 3, 3]], CD[Line[1, 1], Circle[2, 3, 2, 3]], CD[Line[1], Circle[1, 2, 3, 2, 3]], CD[Line[1], Circle[1, 2, 3, 3, 2]], CD[Line[], Circle[1, 1, 2, 3, 3, 2]], CD[Line[1, 2, 1, 2], Circle[3, 3]], CD[Line[], Circle[1, 2, 1, 3, 2, 3]], CD[Line[1, 2], Circle[1, 3, 3, 2]], CD[Line[1, 2, 2, 1], Circle[3, 3]], CD[Line[1, 2, 2], Circle[1, 3, 3]], CD[Line[], Circle[1, 2, 3, 1, 2, 3]], CD[Line[1, 2, 3], Circle[1, 3, 2]], CD[Line[1, 2, 3, 2, 1, 3], Circle[]], CD[Line[1, 2, 3, 2], Circle[1, 3]], CD[Line[1, 2, 3, 3], Circle[1, 2]], CD[Line[1, 2, 3, 2, 3, 1], Circle[]], CD[Line[1, 2, 3, 2, 3], Circle[1]], CD[Line[1, 2, 3, 3, 2, 1], Circle[]], CD[Line[1, 2, 3, 3, 2], Circle[1]]}

Using ASeries objects

Because operations on chord diagrams (such as multiplication and reduction) can often be resource-intensive, it is desirable to work with representations in Java as much as possible. The ASeries object is meant to facilitate this. To create one, use the command ASeries[CDcombo, l, m], where CDcombo is a linear combination of chord diagrams (represented by CD's, and possibly a constant term), all of which are on a fixed skeleton of l lines and m circles, and may have a different number of chords. It is important to note that an ASeries carries with it the notion of an order, defined implicitly by the maximum number of chords to appear in a diagram in CDcombo; the result of any and all computations are only given up to the lowest order appearing therein. (Soon to come: option to explicitly specify order).

There are several operations one can perform on an ASeries object. Addition and multiplication is achieved using the + and . operators respectively. Also, ASeries objects can be inverted (up to the highest order), provided they are of the form (1 + higher order terms) .

Additionally, the following operations are available:

  • AddStrand[ASeries, n] adds an empty strand to all the diagrams in the given ASeries after the n'th position.
  • DoubleStrand[ASeries, n] doubles the n'th strand in all the diagrams in the given ASeries.
  • PermuteStrand[ASeries, perm] applies the permutation perm to the strands of the chord diagrams in the given ASeries. The permutation is to be represented as a list of cycles.

All these operations will be demonstrated in the next section.

Finally, to convert an ASeries back to a human-readable form, use the command: CD[ AS ], where AS is the object to be converted.


Performance Issues

We are currently working to improve the performance of this program. For larger computations, it would likely help to increase the maximum heap size available to Java. To do this, type the following into Mathematica before loading the CDinterface.m definitions (step 1 above):

In[1]:= Needs["JLink`"];
In[2]:= InstallJava[CommandLine -> "/path_to_java_runtime/java -Xmx128M"]

This allows Java to use up to 128 megabytes of memory; you may change the number "128" in the parameter "-Xmx128M" to suit your needs. Note that the first line needs to be entered exactly as shown - the funny apostrophe is located next to the "1" key on many keyboards.