Package schrodinger :: Package structutils :: Module ringspear :: Class Spear

[frames] | no frames]

Class Spear

object --+
         |
        Spear

Contains the atom indexes involved in a ring spear and formats the data in a user-readable string

Instance Methods

__init__(self, spear_indexes, ring_indexes)
Create a Spear object

__repr__(self)
repr(x)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Instance Variables

spear_indexes
List of atom indexes that make the spearing bond

ring_indexes
List of atom indexes of the speared ring

Properties

Inherited from object: __class__

Method Details

init(self, spear_indexes, ring_indexes)
(Constructor)

Create a Spear object

Parameters:

spear_indexes (iterable) - The indexes of the two atoms that make the bond that spears the ring
ring_indexes (iterable) - The atom indexes of the ring that is speared

Overrides: object.__init__

repr(self)
(Representation operator)

repr(x)

Overrides: object.__repr__: (inherited documentation)