ca.pfv.spmf.algorithms.sequentialpatterns.clasp_AGP

Class AlgoClaSP

java.lang.Object

ca.pfv.spmf.algorithms.sequentialpatterns.clasp_AGP.AlgoClaSP

public class AlgoClaSP
extends java.lang.Object

This is an implementation of the ClaSP algorithm. ClaSP was proposed by A. Gomariz et al. in 2013. NOTE: This implementation saves the pattern to a file as soon as they are found or can keep the pattern into memory, depending on what the user choose. Copyright Antonio Gomariz Peñalver 2013 This file is part of the SPMF DATA MINING SOFTWARE (http://www.philippe-fournier-viger.com/spmf). SPMF is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. SPMF is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with SPMF. If not, see .

Field Summary

Fields

Modifier and Type	Field and Description
long	joinCount
long	overallEnd Start and End points in order to calculate the overall time taken by the algorithm
long	overallStart Start and End points in order to calculate the overall time taken by the algorithm

Constructor Summary

Constructors

Constructor and Description
AlgoClaSP(double minSupAbsolute, AbstractionCreator abstractionCreator, boolean findClosedPatterns, boolean executePruningMethods) Constructor of the class that calls ClaSP algorithm.

Method Summary

Modifier and Type	Method and Description
void	clear() It clears all the attributes of AlgoClaSP class
int	getNumberOfFrequentPatterns()
long	getRunningTime() It gets the time spent by the algoritm in its execution.
java.lang.String	printStatistics() Method to show the outlined information about the search for frequent sequences by means of ClaSP algorithm
void	runAlgorithm(SequenceDatabase database, boolean keepPatterns, boolean verbose, java.lang.String outputFilePath) Actual call to ClaSP algorithm.
void	showTree() Method to show the tree in a graphical way

Methods inherited from class java.lang.Object

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

Field Detail

overallStart

public long overallStart

Start and End points in order to calculate the overall time taken by the algorithm

overallEnd

public long overallEnd

Start and End points in order to calculate the overall time taken by the algorithm

joinCount

public long joinCount

Constructor Detail

AlgoClaSP

public AlgoClaSP(double minSupAbsolute,
                 AbstractionCreator abstractionCreator,
                 boolean findClosedPatterns,
                 boolean executePruningMethods)

Constructor of the class that calls ClaSP algorithm.

Parameters:

minSupAbsolute - Absolute minimum support

abstractionCreator - the abstraction creator

findClosedPatterns - flag to indicate if we are interesting in only

Method Detail

runAlgorithm

public void runAlgorithm(SequenceDatabase database,
                         boolean keepPatterns,
                         boolean verbose,
                         java.lang.String outputFilePath)
                  throws java.io.IOException

Actual call to ClaSP algorithm. The output can be either kept or ignore. Whenever we choose to keep the patterns found, we can keep them in a file or in the main memory

Parameters:

database - Original database in where we want to search for the frequent patterns.

keepPatterns - Flag indicating if we want to keep the output or not

verbose - Flag for debugging purposes

outputFilePath - Path of the file in which we want to store the frequent patterns. If this value is null, we keep the patterns in the main memory. This argument is taken into account just when keepPatterns is activated.

Throws:

java.io.IOException

printStatistics

public java.lang.String printStatistics()

Method to show the outlined information about the search for frequent sequences by means of ClaSP algorithm

Returns:

getNumberOfFrequentPatterns

public int getNumberOfFrequentPatterns()

getRunningTime

public long getRunningTime()

It gets the time spent by the algoritm in its execution.

Returns:

clear

public void clear()

It clears all the attributes of AlgoClaSP class

showTree

public void showTree()

Method to show the tree in a graphical way