topsDimension Class Reference

Overview

Represents a discrete, finite spatial dimension.

Each topsDimension object represents one dimension of a finite, discrete space. It has evenly spaced points which define the dimension itself, and a descriptive name.

Properties and Events
Property	name = ''
	string name to describe the dimension

Protected Properties
Property	points = []
	ordered set of points along the dimension
Property	nPoints = 0
	number of points along the dimension
Property	indices = []
	indexes along the dimension, 1 through nPoints
Property	minimum = 0
	the smallest value
Property	maximum = 0
	the largest value
Property	granularity = 1
	mean interval between neighboring points

Methods
self	topsDimension (name, minimum, maximum, nPoints)
	Construct a topsDimension with linearly spaced values. More...
self	setPoints (self, minimum, maximum, nPoints)
	Assign the ordered set of points along this dimension. More...

Constructor

topsDimension()

self topsDimension	(	name	,
		minimum	,
		maximum	,
		nPoints
	)

Construct a topsDimension with linearly spaced values.

Parameters

name	a descriptive name for the dimension
minimum	the least value along the dimension
maximum	the greatest value along the dimension
nPoints	the number of values along the dimension

All parameters are optional. If name is provided, the object will have the given name. If minumum, maximum, and nPoints are provided, the object will have linearly spaced points filled in, spanning minumum and maximum, inclusive. Otherwise, the object will have no points filled in.

Methods

setPoints()

self setPoints	(	self	,
		minimum	,
		maximum	,
		nPoints
	)

Assign the ordered set of points along this dimension.

Parameters

minimum	the least value along the dimension
maximum	the greatest value along the dimension
nPoints	the number of values along the dimension

Computes nPoints linearly spaced points, spanning minumum and maximum, inclusive. Also does realted bookkeeping.

Returns the updated topsDimension object.

---

The documentation for this class was generated from the following file:

• topsDimension.m