Package chemaxon.clustering.libmcs.adapter

Class LegacyLibraryMcsAdapter

java.lang.Object

chemaxon.clustering.libmcs.adapter.LegacyLibraryMcsAdapter

@PublicApi
@Beta
public final class LegacyLibraryMcsAdapter
extends Object

API adapter to use LibraryMcs clustering with the new clustering API.

Please note that this class is marked with the Beta annotation. This class might be changed or completely removed in any of the subsequent releases.

Method Summary

Modifier and Type	Method	Description
static FrameworkClusteringResults	cluster(LegacyLibraryMcsParameters parameters, Iterator<Molecule> molecules)	Launch clustering.
static LegacyLibraryMcsParameters	defaultParameters()	Create default clustering parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

defaultParameters

public static LegacyLibraryMcsParameters defaultParameters()

Create default clustering parameters.

Returns:

Default clustering parameters.

cluster

public static FrameworkClusteringResults cluster(LegacyLibraryMcsParameters parameters,
 Iterator<Molecule> molecules)

Launch clustering.

Parameters:

parameters - Parameters for the underlying LibraryMcs clustering

molecules - Input molecules. Please note that the input molecules will be altered during clustering: they will be aromatized using MoleculeGraph.aromatize() and additional properties (structure index) will be stored.

Returns:

Clustering results. Please note that the retrieval of the original input structures is not a responsibility of the returned results object.