Ising_OPV::Coords Struct Reference

This namespace provides useful constants and utility functions. More...

#include <Utils.h>

Public Member Functions
void	setXYZ (const int xval, const int yval, const int zval)
	Sets the x,y,z coordinates using the input values xval, yval, and zval. More...
bool	operator== (const Coords &rhs) const
	Defines the conditions when two Coords structs are deemed to be equal. More...
bool	operator!= (const Coords &rhs) const
	Defines the conditions when two Coords structs are deemed to be unequal. More...

Public Attributes
int	x
	The x Cartesian coordinate. More...
int	y
	The y Cartesian coordinate. More...
int	z
	The z Cartesian coordinate. More...

Detailed Description

This namespace provides useful constants and utility functions.

Copyright

MIT License. For more information, see the LICENSE file that accompanies this software package.

Author

Michael C. Heiber

Date

2014-2019 This simple struct contains Cartesian coordinates specified by integers x,y,z.

Copyright

MIT License. For more information, see the LICENSE file that accompanies this software package.

Author

Michael C. Heiber

Date

2014-2019

Member Function Documentation

operator!=()

bool Ising_OPV::Coords::operator!= ( const Coords &  rhs ) const

inline

Defines the conditions when two Coords structs are deemed to be unequal.

Parameters

rhs	is the right hand side Coords struct of the comparison operator.

operator==()

bool Ising_OPV::Coords::operator== ( const Coords &  rhs ) const

inline

Defines the conditions when two Coords structs are deemed to be equal.

Parameters

rhs	is the right hand side Coords struct of the comparison operator.

setXYZ()

void Ising_OPV::Coords::setXYZ ( const int  xval, const int  yval, const int  zval  )

inline

Sets the x,y,z coordinates using the input values xval, yval, and zval.

Parameters

xval	is the input x value.
yval	is the input y value.
zval	is the input z value.

Member Data Documentation

x

int Ising_OPV::Coords::x

The x Cartesian coordinate.

y

int Ising_OPV::Coords::y

The y Cartesian coordinate.

z

int Ising_OPV::Coords::z

The z Cartesian coordinate.

---

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

• Utils.h