emergent 8.2.2 XYNGeom Class Reference
emergent 8.2.2   Home · Wiki Docs For: XYNGeom · Emergent Help Browser 

XYNGeom Class Reference

two-dimensional X-Y geometry with possibility of total number n != x*y

See for more info: Wiki Docs For: XYNGeom

 #include <XYNGeom>

defined at: /mnt/ssd/grey/local/include/Emergent/XYNGeom.h :29-64

Inherits From: PosVector2i, taVector2i, taBase

Inherited By: XYNGeom*, XYNGeom&, const XYNGeom

Index: SubTypes, Members, Methods, Static Members, Static Methods, Expert Members, Expert Methods

Sub Types


SubType Documentation


Regular (preferred) Member and Method Documentation

Members

Member Category: _NoCategory

Methods

Method Category: _NoCategory


Member Documentation

Member Category: _NoCategory

XYNGeom::n : int

total number of units (=x*y unless n_not_xy is true)

XYNGeom::n_not_xy : bool

total number of units is less than x * y

taVector2i::x : int

horizontal

taVector2i::y : int

vertical


Method Documentation

Method Category: _NoCategory

void taVector2i::Abs ( )

Show Source Code

bool taVector2i::Clip ( taVector2i& max )

clip coordinates within 0,0 - max range, true if out of range

Show Source Code

void taVector2i::CopyToMatrixGeom ( MatrixGeom& geom )

Show Source Code

void taVector2i::CopyToMatrixIndex ( MatrixIndex& idx )

Show Source Code

float taVector2i::Dist ( taVector2i& td )

Show Source Code

bool XYNGeom::FitN ( int no )

adjust x and y to fit x total elements

Show Source Code

void taVector2i::FromMatrix ( taMatrix& mat )

set values from a matrix object (can be any type of matrix object)

Show Source Code

taString taVector2i::GetStr ( )

Show Source Code

TypeDef* XYNGeom::GetTypeDef ( )

Show Source Code

void taVector2i::GetXY ( float& xx, float& yy )

Show Source Code

void taVector2i::Invert ( )

Show Source Code

float taVector2i::Mag ( )

Show Source Code

void taVector2i::Max ( taVector2i& td )

Show Source Code

int taVector2i::MaxVal ( )

Show Source Code

void taVector2i::Min ( taVector2i& td )

Show Source Code

int taVector2i::MinVal ( )

Show Source Code

bool taVector2i::OrEq ( taVector2i& td )

Show Source Code

int taVector2i::Product ( )

Show Source Code

void taVector2i::SetFmIndex ( int idx, int x_size )

set x, y values from a 'cell' index in a 2d matrix-like space organized with x as the inner loop and y as the outer loop, with a given x dimension size

Show Source Code

void taVector2i::SetGtEq ( int n )

set each to be greater than or equal to n

Show Source Code

void taVector2i::SetLtEq ( int n )

set each to be less than or equal to n

Show Source Code

void taVector2i::SetXY ( float xx, float yy )

Show Source Code

void XYNGeom::SetXYN ( int xx, int yy, int nn )

set x, y, and n in one step

Show Source Code

float taVector2i::SqDist ( taVector2i& td )

Show Source Code

int taVector2i::SqMag ( )

squared magnitude of vector

Show Source Code

int taVector2i::Sum ( )

Show Source Code

void taVector2i::SumNorm ( )

Show Source Code

void taVector2i::ToMatrix ( taMatrix& mat )

set values to a 1d matrix object (can be any type of matrix object)

Show Source Code

void XYNGeom::UpdateFlag ( )

update the n_not_xy flag from the current x,y,n values

Show Source Code

void XYNGeom::UpdateNfmXY ( )

update x,y from N

Show Source Code

void XYNGeom::UpdateXYfmN ( )

update x,y from existing n, including updating the n_not_xy flag

Show Source Code

void taVector2i::Wrap ( taVector2i& max )

wrap-around coordinates within 0,0 - max range

Show Source Code

bool taVector2i::WrapClip ( bool wrap, taVector2i& max )

wrap-around or clip coordinates within 0,0 - max range, true if clipped out of range -- for performance, it is better to use separate code for wrap and clip cases

Show Source Code

bool taVector2i::WrapHalf ( taVector2i& max )

wrap-around coordinates within 0,0 - max range, return true if out of range (more than half way around other side)

Show Source Code

void taVector2i::WrapMinDist ( taVector2i& dst, taVector2i& max, taVector2i& cmp, taVector2i& cmp_half )

in computing the distance between two coords: dst = this-cmp, consider whether the distance is shorter if this is wrapped around as a function of pos_max size (condition on which side of the half-way point of the range for cmp value, cmp_half, for which way to wrap) -- if it is shorter, then update this pos to new extended value (beyond normal range either - or +) and also update the distance value

Show Source Code

bool taVector2i::isZero ( )

Show Source Code

Static Member and Method Documentation

Static Members

Static Methods

Static Method Category: _NoCategory


Static Method Documentation

Static Method Category: _NoCategory

int taVector2i::Absv ( int val )   [static]

Show Source Code

bool taVector2i::ClipOne ( int& c, int max )   [static]

clip one dimension, true if out of range

Show Source Code

int taVector2i::Sgn ( int val )   [static]

Show Source Code

int taVector2i::WrapMax ( int c, int max )   [static]

Show Source Code

void taVector2i::WrapMinDistOne ( int& pos, int& dst, const int pos_max, const int cmp, const int cmp_half )   [static]

in computing the distance between two coord vals: dst = pos-cmp, consider whether the distance is shorter if pos is wrapped around as a function of pos_max size (condition on which side of the half-way point of the range for cmp value, cmp_half, for which way to wrap) -- if it is shorter, then update pos to new extended value (beyond normal range either - or +) and also update the distance value

Show Source Code

void taVector2i::WrapOne ( int& c, int max )   [static]

wrap-around one dimension

Show Source Code

bool taVector2i::WrapOneHalf ( int& c, int max )   [static]

wrap-around one dimension, return true if out of range (more than half way around other side)

Show Source Code

Expert Member and Method Documentation

Expert Members

Expert Member Category: _NoCategory

Expert Methods


Expert Member Documentation

Expert Member Category: _NoCategory

XYNGeom::z : int

legacy v3 third dimension -- used for conversion only -- do not use!! to be removed at some later date


Expert Method Documentation


Copyright © 2017Regents of the University of Colorado, Carnegie Mellon University, Princeton University.
emergent 8.2.2