---

SmallRing Class Reference

A SmallRing contains a list of atoms which are connected to each other to form a loop. The atom numbers are the unique atom numbers as used in BaseMolecule. The ordering of the atoms, in addition to specifying how the atoms in the ring are connected, also gives the orientation (handedness) of the ring if orientated is non-zero. More...

#include <SmallRing.h>

List of all members.

Public Methods
	SmallRing (void)
int	num (void)
int	operator[] (int i)
void	append (int i)
int	last_atom (void)
int	first_atom (void)
int	closed (void)
void	remove_last (void)
void	reverse (void)
void	clear (void)
SmallRing *	copy (void)
Public Attributes
ResizeArray< int >	atoms
short int	orientated
Friends
Inform &	operator<< (Inform &os, SmallRing &sr)

---

Detailed Description

A SmallRing contains a list of atoms which are connected to each other to form a loop. The atom numbers are the unique atom numbers as used in BaseMolecule. The ordering of the atoms, in addition to specifying how the atoms in the ring are connected, also gives the orientation (handedness) of the ring if orientated is non-zero.

Definition at line 37 of file SmallRing.h.

---

Constructor & Destructor Documentation

SmallRing::SmallRing (  void    )  [inline]

Definition at line 42 of file SmallRing.h. References orientated. Referenced by copy.

---

Member Function Documentation

void SmallRing::append (  int    i )  [inline]

Definition at line 46 of file SmallRing.h. References ResizeArray::append. Referenced by LinkagePath::append, and copy.

void SmallRing::clear (  void    )  [inline]

Definition at line 63 of file SmallRing.h. References ResizeArray::clear, and orientated.

int SmallRing::closed (  void    )  [inline]

Definition at line 50 of file SmallRing.h. References first_atom, and last_atom.

SmallRing* SmallRing::copy (  void    )  [inline]

Definition at line 68 of file SmallRing.h. References append, num, orientated, and SmallRing. Referenced by LinkagePath::copy.

int SmallRing::first_atom (  void    )  [inline]

Definition at line 49 of file SmallRing.h. Referenced by closed.

int SmallRing::last_atom (  void    )  [inline]

Definition at line 48 of file SmallRing.h. References ResizeArray::num. Referenced by closed.

int SmallRing::num (  void    )  [inline]

Definition at line 44 of file SmallRing.h. References ResizeArray::num. Referenced by SmallRingLinkages::addLinkagePath, copy, cremer_pople_ring_color, hill_reilly_ring_pucker, LinkagePath::num, and SmallRingLinkages::sharesLinkageEdges.

int SmallRing::operator[] (  int    i )  [inline]

Definition at line 45 of file SmallRing.h.

void SmallRing::remove_last (  void    )  [inline]

Definition at line 51 of file SmallRing.h. References ResizeArray::truncatelastn. Referenced by LinkagePath::remove_last.

void SmallRing::reverse (  void    )  [inline]

Definition at line 53 of file SmallRing.h. References ResizeArray::append, ResizeArray::clear, and ResizeArray::num.

---

Friends And Related Function Documentation

Inform& operator<< (  Inform &    os, SmallRing &    sr )  [friend]

Definition at line 80 of file SmallRing.h.

---

Member Data Documentation

ResizeArray<int> SmallRing::atoms

Definition at line 39 of file SmallRing.h.

short int SmallRing::orientated

Definition at line 40 of file SmallRing.h. Referenced by clear, copy, and SmallRing.

---

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

• SmallRing.h

---