Class ZagrebIndexDescriptor
- java.lang.Object
-
- org.openscience.cdk.qsar.AbstractMolecularDescriptor
-
- org.openscience.cdk.qsar.descriptors.molecular.ZagrebIndexDescriptor
-
- All Implemented Interfaces:
IDescriptor
,IMolecularDescriptor
public class ZagrebIndexDescriptor extends AbstractMolecularDescriptor implements IMolecularDescriptor
Zagreb index: the sum of the squares of atom degree over all heavy atoms i.- Author:
- mfe4
- Dictionary pointer(s):
- zagrebIndex in the QSAR.sf.net Descriptors Dictionary [qsar-descriptors:zagrebIndex]
- Source code:
- main
- Belongs to CDK module:
- qsarmolecular
- Keywords:
- Zagreb index, descriptor
- Created on:
- 2004-11-03
-
-
Constructor Summary
Constructors Constructor Description ZagrebIndexDescriptor()
Constructor for the ZagrebIndexDescriptor object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescriptorValue
calculate(IAtomContainer atomContainer)
Evaluate the Zagreb Index for a molecule.String[]
getDescriptorNames()
Returns an array of names for each descriptor value calculated.IDescriptorResult
getDescriptorResultType()
Returns the specific type of the DescriptorResult object.String[]
getParameterNames()
Gets the parameterNames attribute of the ZagrebIndexDescriptor object.Object[]
getParameters()
Gets the parameters attribute of the ZagrebIndexDescriptor object.Object
getParameterType(String name)
Gets the parameterType attribute of the ZagrebIndexDescriptor object.DescriptorSpecification
getSpecification()
Gets the specification attribute of the ZagrebIndexDescriptor object.void
initialise(IChemObjectBuilder builder)
Default implementation of initialise allows optional override.void
setParameters(Object[] params)
Sets the parameters attribute of the ZagrebIndexDescriptor object.-
Methods inherited from class org.openscience.cdk.qsar.AbstractMolecularDescriptor
clone
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.openscience.cdk.qsar.IDescriptor
initialise
-
-
-
-
Method Detail
-
getSpecification
public DescriptorSpecification getSpecification()
Gets the specification attribute of the ZagrebIndexDescriptor object.- Specified by:
getSpecification
in interfaceIDescriptor
- Returns:
- The specification value
-
setParameters
public void setParameters(Object[] params) throws CDKException
Sets the parameters attribute of the ZagrebIndexDescriptor object.- Specified by:
setParameters
in interfaceIDescriptor
- Parameters:
params
- The new parameters value- Throws:
CDKException
- Description of the Exception- See Also:
getParameters()
-
getParameters
public Object[] getParameters()
Gets the parameters attribute of the ZagrebIndexDescriptor object.- Specified by:
getParameters
in interfaceIDescriptor
- Returns:
- The parameters value
- See Also:
setParameters(java.lang.Object[])
-
getDescriptorNames
public String[] getDescriptorNames()
Description copied from interface:IDescriptor
Returns an array of names for each descriptor value calculated. Many descriptors return multiple values. In general it is useful for the descriptor to indicate the names for each value. In many cases, these names can be as simple as X1, X2, ..., XN where X is a prefix and 1, 2, ..., N are the indices. On the other hand it is also possible to return other arbitrary names, which should be documented in the Javadocs for the descriptor (e.g., the CPSA descriptor). Note that by default if a descriptor returns a single value (such asALOGPDescriptor
the return array will have a single element- Specified by:
getDescriptorNames
in interfaceIDescriptor
- Returns:
- An array of descriptor names, equal in length to the number of descriptor calculated..
-
calculate
public DescriptorValue calculate(IAtomContainer atomContainer)
Evaluate the Zagreb Index for a molecule.- Specified by:
calculate
in interfaceIMolecularDescriptor
- Parameters:
atomContainer
- AtomContainer- Returns:
- zagreb index
-
getDescriptorResultType
public IDescriptorResult getDescriptorResultType()
Returns the specific type of the DescriptorResult object. The return value from this method really indicates what type of result will be obtained from theDescriptorValue
object. Note that the same result can be achieved by interrogating theDescriptorValue
object; this method allows you to do the same thing, without actually calculating the descriptor.- Specified by:
getDescriptorResultType
in interfaceIMolecularDescriptor
- Returns:
- an object that implements the
IDescriptorResult
interface indicating the actual type of values returned by the descriptor in theDescriptorValue
object
-
getParameterNames
public String[] getParameterNames()
Gets the parameterNames attribute of the ZagrebIndexDescriptor object.- Specified by:
getParameterNames
in interfaceIDescriptor
- Returns:
- The parameterNames value
-
getParameterType
public Object getParameterType(String name)
Gets the parameterType attribute of the ZagrebIndexDescriptor object.- Specified by:
getParameterType
in interfaceIDescriptor
- Parameters:
name
- Description of the Parameter- Returns:
- The parameterType value
-
initialise
public void initialise(IChemObjectBuilder builder)
Default implementation of initialise allows optional override.- Specified by:
initialise
in interfaceIDescriptor
- Parameters:
builder
- chem object build
-
-