Make object the current object.

• An object can also be selected by clicking on it in the canvas or in the browser.
• object can either be a graphical object or a folder.
• The current object can be retrieved with current_object() and the current folder with current_folder().
• scope .. will make the parent of the current object the current object.

scope welcome_page;
repaint;

create Folder DATA;
scope DATA;
import_report("data.dat");

OLDPAGE = current_page();
scope page_1;
print;
scope $OLDPAGE;

for PAGE in all("Page")
  scope $PAGE;
  TileViewports();
endfor

current_object, current_folder, current_page

• t can either be a time dataset or a string in one of the formats supported by the function timeformat1.

hournumber, minutenumber, totime

hourrange, minuterange, midhourrange

• t can be a string in time format or a real time dataset.
• secsince can be used to convert times to numbers for processing or for use with a user-defined axis.
• If necessary the numbers can be converted back to dates with invsecsince

nextMinute = invsecsince(secsince(time)+(1:3600));

• Set the seed to a constant value if you want to get reproducible random numbers
• Use seed(secsince(time)) if you want to make sure the numbers are different every time

seed(0);
echo(rnd(10));
seed(0);
echo(rnd(10));

• The syntax of the set command is identical to the create command except it begins set object rather than create objectType object. See the create comand for more details.

• If you only want to set one resouce then it is easier to use an assignment statement e.g.

  page_1.XuNshowMargins = false;

  rather than

  set page_1 ( XuNshowMargins = false );

  N.B. You cannot use an assignment if you want to include units e.g.

  set page_1.viewport_2(XuNfirstDiagonalPoint = (1,1) mm);

• You can use the set command to rename an object:

  set WORK.T1 ( XuNname = "Height" );

set textoption
 ( XuNsuperscriptChar = ">",
   XuNsubscriptChar = "<",
   XuNnewlineChar = "|"
 );

• All output in Gsharp is either an error, a warning, information or a user message
• By default all message types are switched on.
• Use get_messages to retrieve the current status.
• The output of the echo and printf commands is controlled by the user flag.

get_messages

• The default value is 999.999.
• set_undef() will return undef to its default value.
• You can also use the if() command to change the data:

  mydata = if(mydata=-1, undef, mydata);

if

• Returns true if succesful, false if unsuccesful
• directory can include environment variables
• backslashes have a special meaning in GSL strings. Use "\\" if you need "\". e.g. "c:\\program files\\mydata". Gsharp will also accept a forward slash as a platform independent directory separator. e.g. "$UNIDIR/example/Gsharp" will work on both UNIX and Windows.

getdir

• state must either be "sensitive" or "insensitive"
• You can also set $object.XuNguiSensitive

getdir

• If no pattern is specified all countries are listed. They are ordered alphabetically by country name
• caseSensitive can be either "case" or "no_case" (default).

getcountry, getcode, showcountry, import_worldmap, Country Codes

• If no pattern is specified all countries are listed. They are ordered alphabetically by country code
• Only one code can be specified at a time. To do more use:

  echo(getcountry("DEN"//"POL"));

getcountry, getcode, showcode, import_worldmap, Country Codes

• If an element is zero it returns zero
• If an element is greater than zero it returns 1.0
• If an element is less than zero it returns -1.0

x

abs

Returns the sine of each member of x.

• x must be specified in radians. If it is in degrees use sin(x/180*pi)
• values returned range from -1 to 1

Returns the hyperbolic sine of each element of x.

• x must be specified in radians. If it is in degrees use sin(x/180*pi)
• values returned range from -1 to 1

• size(x) is equal to sizex(x)*sizey(x)*sizez(x)

x = rnd(100); y = rnd(100);
linenums = LineNumbers(x>.9);

for i in linenums
  printf("x[%d] = %g, y[%d] = %g\n", i, x[i], i, y[i]);
endfor
  

• size(x) is equal to sizex(x)*sizey(x)*sizez(x)

grid = bilinear(rnd(9),rnd(9),rnd(9),20,20);
create Viewport page_1.viewport_1;
create Domain page_1.viewport_1.domain_1;
create Graph page_1.viewport_1.domain_1.graph_1
 ( XuNcolorDataGrid = "grid",
   XuNgraphType = "2DContour"
 );
repaint;
grid = slicex(grid,sizex(grid):1);
repaint;
grid = slicey(grid,sizey(grid):1);
repaint;
grid = transpose(grid); 

• slice(x, rows, columns, planes) is equivalent to:

  slicez(slicey(slicex(x,rows),columns),planes);

• If rows, columns or planes equals 0 then all relevant slices are returned.

  slice(x,0,0,0) is equivalent to x.         

• To return a single slice you can use array indexing instead of slice:

  block[,,1]  #first plane
  grid[,2]  #second column         

slice(x,1,0,2)

slice(x,1:3,1;3,0)

slice(x,1,2,3)

slicex(x,0,1//3//5,1)

grid = bilinear(rnd(9),rnd(9),rnd(9),19,19);
simplegrid = slice(grid,1//10//19,1//10//19,1);

#Extract small section of grid

grid = bilinear(rnd(9),rnd(9),rnd(9),59,59);
gridsection = slice(grid,23:29,32:40,1);

• slicex(x, rows) is equivalent to:slice(x,rows,0,0);
• slicex(x,0) returns the whole of x
• slicex(x,1) returns the first row of x
• slicex(x,1:10) returns the first ten rows of x
• slicex(x,sizex(x):1) returns x with the rows in reverse order.

slicey and slicez work in the same way.

• Use the function slice to slice in more than one direction at one time.
  slice(x, rows, columns, planes) is equivalent to:

  slicez(slicey(slicex(x,rows),columns),planes);

• Use dropx, dropy and dropz to return x without the specified slices
• slicex is very useful for indexing into an array of values. See Sample code 2

grid = bilinear(rnd(9),rnd(9),rnd(9),19,19);
invertgrid = slicex(grid,sizex(grid):1);

#Get random days

days = "Sun"//"Mon"//"Tue"//"Wed"//"Thu"//"Fri"//"Sat";
dayCodes = int(rnd(100)*7+1);
dayNames = slicex(days,dayCodes);

• A value is calculated for each x value in xnodes. If xnodes is a single value, n, then range(x,n) is used. If xnodes is not specified then range(x,33) is used
• smoothing is an integer from 1 to 9 that controls the level of smoothing. The default value is 1.
• Read more about the smooth function in How do I fit a line?

• x can be of any data type - float, string, date or time
• To sort into descending order use:

  reverse(sort(x))

• x can be of any data type - float, string, date or time
• This function is used to sort a group of datasets with corresponding elements:

  y = sortby(y,x);
  x = sort(x);

  It is important that the sort is performed last after all the sortby's.
  

• If you have a dataset y containing the order that you would like to have x in - then use slicex:

  x = slicex(x,y);

x

• A value is calculated for each x value in xnodes. If xnodes is a single value, n, then range(x,n) is used. If xnodes is not specified then range(x,33) is used
• tension is an integer from 1 to 10 that controls the tautness of the line about the input points. The default value is 1.
• Read more about the spline function in How do I fit a line?

• See printf for details

printf, fprintf

exp, log10

• The standard deviation is the square root of the variance.
• The variance is the sum of the squares of x-avg(x)
• To find the standard deviation of each row of x use:

  stdx(transpose(x))

• If n is a non-integer, nint(n) is used.

See also:

step2, nint

• If n1 or n2 is a non-integer then nint(n1) and nint(n2) are used.

step, nint

Stop executing GSL scripts.

• Stops current script and outputs the current function stack.

• If the current script has been exec()'ed by another script then stop will only stop the current script - execution will continue after the exec() command in the calling script.

• If you want to quit Gsharp then you can either use the built-in callback GuiFileExit, which prompts for confirmation before quitting or the command quit, which quits without any questions.

• the first occurence of the character c - strchr
• the last occurence of the character c - strrchr
• the first occurence of the string s2 - strstr

If a match is not found then undef is returned for that element

• Only the first character of the string c is recognized.

strchr("This is it","i")

"is is it"

strrchr("This is it","i")

"it"

strstr("This is it"," is")

" is it"

strchr("C:\\Program Files\\Bob","\\")

"\\Bob"

strlen, substr, match

"Hello"
""
"C:\\"

5
0
3

strchr, strrchr, strstr, substr, match

• If an element cannot be converted undef is returned for that element

"1e2"
""
"4"
"1+1"

100
0
4
undef

valuestr

• If there are less than n1 characters in an element then undef is returned for that element.
• If there are less then n2 characters in an element then the substring continues until the end of the string.

"The whole string"

"he "

#drop first two characters of myarray
myarray = substr(s,3,1024);

strchr, strrchr, strstr, strlen, match

• Any undef values are ignored

2
undef
3

5

sumx

• Any undef values are ignored
• The result is returned as a column dataset. If you would prefer a row dataset use:

  transpose(sumx(x))

• To find the sum of each row use:

  sumx(transpose(x))

1   2   3
4   3   2

5
5
5

sum

• To get output from the system command, pipe the output to a file and then read it in
• Gsharp waits for the system command to exit before continuing execution

os_type