org.openscience.cdk.hash.stereo

Interface StereoEncoder

public interface StereoEncoder

An encoder for stereo chemistry. The stereo configuration is encoded by checking the current[] invariant values. If there is a configuration then the appropriate value is the next[] is modified.

Author:

John May

Belongs to CDK module:

hash

Field Summary

Fields

Modifier and Type	Field and Description
static StereoEncoder	EMPTY empty stereo encoder when no stereo can be perceived

Method Summary

Modifier and Type	Method and Description
boolean	encode(long[] current, long[] next) Encode one or more stereo elements based on the current invariants.
void	reset() Reset the stereo-encoders, any currently perceived configurations will be re-activated.

Field Detail

EMPTY

static final StereoEncoder EMPTY

empty stereo encoder when no stereo can be perceived

Method Detail

encode

boolean encode(long[] current,
               long[] next)

Encode one or more stereo elements based on the current invariants. If any stereo element are uncovered then the corresponding value in the next[] array is modified.

Parameters:

current - current invariants

next - next invariants

Returns:

whether any stereo configurations were encoded

reset

void reset()

Reset the stereo-encoders, any currently perceived configurations will be re-activated.