Class TrigonalBipyramidal
java.lang.Object
org.openscience.cdk.stereo.TrigonalBipyramidal
- All Implemented Interfaces:
Cloneable, ICDKObject, IStereoElement<IAtom,IAtom>
Describes a trigonal-bipyramidal configuration. The configuration carriers
are arranged with two co-linear on an axis and three equatorial. The
configuration order is between 1 and 20 and follows the same meaning as
SMILES.
d c TB1
\ /
a---x---e where a: first carrier, b: second carrier, ... *
| x: focus
b 'c' is in front of 'x', 'd' is behind
The configuration can be normalized to the lowest order (1) using the
normalize() function.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intprotected static final intFields inherited from interface IStereoElement
AL, Allenal, AT, Atropisomeric, CFG_MASK, CisTrans, CLS_MASK, CT, CU, Cumulene, GRP_ABS, GRP_MASK, GRP_NUM_MASK, GRP_NUM_SHIFT, GRP_RAC, GRP_RAC1, GRP_RAC2, GRP_RAC3, GRP_RAC4, GRP_RAC5, GRP_REL, GRP_REL1, GRP_REL2, GRP_REL3, GRP_REL4, GRP_REL5, GRP_TYPE_MASK, HBPY8, HBPY9, HeptagonalBipyramidal, HexagonalBipyramidal, LEFT, OC, Octahedral, OPPOSITE, PBPY, PentagonalBipyramidal, RIGHT, SP, SP4, SPU, SPY, SPZ, SquarePlanar, SquarePyramidal, TBPY, Tetrahedral, TH, TOGETHER, TrigonalBipyramidalModifier and TypeFieldDescriptionstatic final intExtendedTetrahedral a.k.a. allene (e.g. 2,3-pentadiene)static final intExtendedTetrahedral (e.g. 2,3-pentadiene)static final intAtropisomeric (e.g.static final intAtropisomeric (e.g.static final intstatic final intGeometric CisTrans (e.g. but-2-ene)static final intstatic final intGeometric CisTrans (e.g. but-2-ene)static final intExtendedCisTrans a.k.a. cumulene (e.g. hexa-2,3,4-triene)static final intCumulenestatic final intAbsolute stereo group, the exact stereo configuration of this atom is known.static final intMask for the stereo group informationstatic final intMask for the stereo group number information, 0x0 .. 0xf (1..15)static final intstatic final intRacemic stereo group type, the stereo configuration of this atom is a mixture of R/S.static final intConvenience field for testing if the stereo is group RAC1 (&1).static final intConvenience field for testing if the stereo is group RAC2 (&2).static final intConvenience field for testing if the stereo is group RAC3 (&3).static final intConvenience field for testing if the stereo is group RAC4 (&4).static final intConvenience field for testing if the stereo is group RAC5 (&5).static final intRelative stereo group type, the stereo configuration of this atom is unknown but is relative to another atom in the same group.static final intConvenience field for testing if the stereo is group OR1 (&1).static final intConvenience field for testing if the stereo is group OR2 (&2).static final intConvenience field for testing if the stereo is group OR3 (&3).static final intConvenience field for testing if the stereo is group OR4 (&4).static final intConvenience field for testing if the stereo is group OR5 (&5).static final intMask for the stereo group type information, GRP_ABS, GRP_AND, GRP_ORstatic final intHexagonal Bipyramidal (HBPY-8)static final intHeptagonal Bipyramidal (HBPY-9)static final intHeptagonal Bipyramidal (HBPY-9)static final intHexagonal Bipyramidal (HBPY-8)static final intstatic final intOctahedral (OC-6)static final intOctahedral (OC-6)static final intstatic final intPentagonal Bipyramidal (PBPY-7)static final intPentagonal Bipyramidal (PBPY-7)static final intstatic final intSquare Planar (SP-4) (e.g. cisplatin)static final intSquare Planar Configutation in 4 Shapestatic final intSquare Planar Configutation in U Shapestatic final intSquare Pyramidal (SPY-5)static final intSquare Planar Configutation in Z Shapestatic final intSquare Planar (SP-4) (e.g. cisplatin)static final intSquare Pyramidal (SPY-5)static final intTrigonal Bipyramidal (TBPY-5)static final intTetrahedral (T-4) (e.g. butan-2-ol)static final intTetrahedral (T-4) (e.g. butan-2-ol)static final intstatic final intTrigonal Bipyramidal (TBPY-5) -
Constructor Summary
ConstructorsConstructorDescriptionTrigonalBipyramidal(IAtom focus, IAtom[] carriers, int order) Create a new trigonal bipyramidal configuration. -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanDoes the stereo element contain the provided atom.protected TrigonalBipyramidalReturns aIChemObjectBuilderfor the data classes that extend this class.The carriers of the stereochemistryintAccess the configuration order and class of the stereochemistry.intThe configuration class of the stereochemistry.intThe configuration order of the stereochemistry.getFocus()The focus atom or bond at the 'centre' of the stereo-configuration.intAccess the stereo group information - see class doc.protected static <T> T[]invapply(T[] src, int[] perm) Map the atoms/bonds in this instance to a new stereo element using the provided atom/bond mapping.map(Map<IChemObject, IChemObject> chemobjs) Update the stereo using the remapping of atoms/bonds in this instance to a new stereo element using the provided atom/bond mapping.final IStereoElement<IAtom, IAtom> mapStrict(Map<IChemObject, IChemObject> chemobjs) Update the stereo using the remapping of atoms/bonds in this instance to a new stereo element using the provided atom/bond mapping.Normalize the configuration to the lowest configuration order (1) - the axis goes from the first to last carrier, the three middle carriers are anti-clockwise looking from the first carrier.protected static intnumCarriers(int cfg) protected IAtom[]processCarriers(IAtom focus, IAtom[] carriers) Hook for subclasses to process carriers before they are stored, e.g., to enforce a constraint.static intprotected voidsetBuilder(IChemObjectBuilder builder) voidsetConfigOrder(int cfg) Set the configuration order of the stereochemistry.voidsetGroupInfo(int grp) Set the stereo group information - see class doc.updateCarriers(IAtom remove, Iterable<IAtom> adds) updateCarriers(Set<IAtom> remove, IAtom rep) Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface IStereoElement
updateCarriersModifier and TypeMethodDescriptiondefault IStereoElement<IAtom, IAtom> updateCarriers(IAtom remove, IAtom rep)
-
Field Details
-
A
protected static final int A- See Also:
-
B
protected static final int B- See Also:
-
C
protected static final int C- See Also:
-
D
protected static final int D- See Also:
-
E
protected static final int E- See Also:
-
F
protected static final int F- See Also:
-
-
Constructor Details
-
TrigonalBipyramidal
-
-
Method Details
-
normalize
Normalize the configuration to the lowest configuration order (1) - the axis goes from the first to last carrier, the three middle carriers are anti-clockwise looking from the first carrier.- Returns:
- the normalized configuration
-
create
-
reorder
-
canBeOctahedral
public boolean canBeOctahedral() -
asOctahedral
-
numCarriers
protected static int numCarriers(int cfg) -
processCarriers
Hook for subclasses to process carriers before they are stored, e.g., to enforce a constraint. The default implementation returns the carriers as-is.- Parameters:
focus- the focuscarriers- the carriers- Returns:
- the processed carriers
-
getFocus
The focus atom or bond at the 'centre' of the stereo-configuration.- Specified by:
getFocusin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Returns:
- the focus
-
getCarriers
The carriers of the stereochemistry- Specified by:
getCarriersin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Returns:
- the carriers
-
getConfigClass
public int getConfigClass()The configuration class of the stereochemistry.- Specified by:
getConfigClassin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Returns:
- configuration class
-
getConfigOrder
public int getConfigOrder()The configuration order of the stereochemistry.- Specified by:
getConfigOrderin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Returns:
- configuration
-
getConfig
public int getConfig()Access the configuration order and class of the stereochemistry.- Specified by:
getConfigin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Returns:
- the configuration
-
setConfigOrder
public void setConfigOrder(int cfg) Set the configuration order of the stereochemistry.- Specified by:
setConfigOrderin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Parameters:
cfg- the new configuration
-
getGroupInfo
public int getGroupInfo()Access the stereo group information - see class doc.- Specified by:
getGroupInfoin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Returns:
- the group info
-
setGroupInfo
public void setGroupInfo(int grp) Set the stereo group information - see class doc.- Specified by:
setGroupInfoin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Parameters:
grp- the group info
-
contains
Does the stereo element contain the provided atom.- Specified by:
containsin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Parameters:
atom- an atom to test membership- Returns:
- whether the atom is present
-
map
Map the atoms/bonds in this instance to a new stereo element using the provided atom/bond mapping. This allows the stereo element to be transferred between a cloned or aligned (i.e. isomorphic) chemical graph. If no mapping is found for a given atom or bond it is left intact. However the provided atom and bonds maps must not be null.- Specified by:
mapin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Parameters:
atoms- used to convert the original atoms to their mapped counterpartsbonds- used to convert the original bonds to their mapped counterparts- Returns:
- a new stereo element in the same configuration but with atoms/bonds replaced with their mapped equivalence.
-
map
Description copied from interface:IStereoElementUpdate the stereo using the remapping of atoms/bonds in this instance to a new stereo element using the provided atom/bond mapping. This allows the stereo element to be transferred between a cloned or aligned (i.e. isomorphic) chemical graph. If no mapping is found for a given atom or bond the existing atom/bond it is left intact. If you want to remove stereo in such cases please useIStereoElement.mapStrict(Map).- Specified by:
mapin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Parameters:
chemobjs- chem object mapping- Returns:
- a new stereo element in the same configuration but with atoms/bonds replaced with their mapped equivalence.
-
updateCarriers
- Specified by:
updateCarriersin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>
-
updateCarriers
- Specified by:
updateCarriersin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>
-
mapStrict
Description copied from interface:IStereoElementUpdate the stereo using the remapping of atoms/bonds in this instance to a new stereo element using the provided atom/bond mapping. This allows the stereo element to be transferred between a cloned or aligned (i.e. isomorphic) chemical graph. If no mapping is found for a given atom or bond a new element is NOT created.- Specified by:
mapStrictin interfaceIStereoElement<F extends IChemObject, C extends IChemObject>- Parameters:
chemobjs- chem object mapping- Returns:
- a new stereo element in the same configuration but with atoms/bonds replaced with their mapped equivalence.
-
getBuilder
Returns aIChemObjectBuilderfor the data classes that extend this class.- Specified by:
getBuilderin interfaceICDKObject- Returns:
- The
IChemObjectBuildermatching thisICDKObject
-
setBuilder
-
invapply
protected static <T> T[] invapply(T[] src, int[] perm)
-