org.openscience.cdk.hash

Interface AtomEncoder

All Known Implementing Classes:

BasicAtomEncoder

public interface AtomEncoder

An encoder for invariant atom properties. The encoders are used to seed the the generation of atomic hash codes.

Author:

John May

See Also:

AtomHashGenerator

Source code:

master

Belongs to CDK module:

interfaces

Method Summary

Methods

Modifier and Type	Method and Description
int	encode(IAtom atom, IAtomContainer container) Encode an invariant attribute of the given atom.

Method Detail

encode

int encode(IAtom atom,
         IAtomContainer container)

Encode an invariant attribute of the given atom. The atom and container should not to be null.

Parameters:

atom - non-null atom belonging to the container

container - non-null container

Returns:

encoding of an invariant atom attribute