ca.pfv.spmf.algorithms.sequentialpatterns.BIDE_and_prefixspan

Class AlgoFSGP

java.lang.Object

ca.pfv.spmf.algorithms.sequentialpatterns.BIDE_and_prefixspan.AlgoFSGP

public class AlgoFSGP
extends java.lang.Object

This is an implementation of the FSGP algorithm. FSGP is an algorithm proposed by Yi et al (2011-2012) Copyright (c) 2008-2014 Philippe Fournier-Viger 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
int	minsuppRelative
int	prefixPrunedCount

Constructor Summary

Constructors

Constructor and Description
AlgoFSGP() Default constructor

Method Summary

Modifier and Type	Method and Description
int	getMaximumPatternLength() Get the maximum length of patterns to be found (in terms of item count)
long	getPatternCount()
void	printStatistics(int size) Print statistics about the algorithm execution to System.out.
java.util.List<SequentialPattern>	runAlgorithm(SequenceDatabase database, double minsupPercent, java.lang.String outputFilePath, boolean performPruning) Run the algorithm
java.util.List<SequentialPattern>	runAlgorithm(SequenceDatabase database, java.lang.String outputFilePath, int minsup, boolean performPruning) Run the algorithm
void	setMaximumPatternLength(int maximumPatternLength) Set the maximum length of patterns to be found (in terms of item count)

Methods inherited from class java.lang.Object

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

Field Detail

minsuppRelative

public int minsuppRelative

prefixPrunedCount

public int prefixPrunedCount

Constructor Detail

AlgoFSGP

public AlgoFSGP()

Default constructor

Method Detail

runAlgorithm

public java.util.List<SequentialPattern> runAlgorithm(SequenceDatabase database,
                                                      double minsupPercent,
                                                      java.lang.String outputFilePath,
                                                      boolean performPruning)
                                               throws java.io.IOException

Run the algorithm

Parameters:

database - : a sequence database

minsupPercent - : the minimum support as a percentage (e.g. 50%)

outputFilePath - : the path of the output file to save the result or null if you want the result to be saved into memory

Returns:

return the result, if saved into memory, otherwise null

Throws:

java.io.IOException - exception if error while writing the file

runAlgorithm

public java.util.List<SequentialPattern> runAlgorithm(SequenceDatabase database,
                                                      java.lang.String outputFilePath,
                                                      int minsup,
                                                      boolean performPruning)
                                               throws java.io.IOException

Run the algorithm

Parameters:

database - : a sequence database

minsupPercent - : the minimum support as an integer

outputFilePath - : the path of the output file to save the result or null if you want the result to be saved into memory

Returns:

return the result, if saved into memory, otherwise null

Throws:

java.io.IOException - exception if error while writing the file

getPatternCount

public long getPatternCount()

printStatistics

public void printStatistics(int size)

Print statistics about the algorithm execution to System.out.

Parameters:

size - the size of the database

getMaximumPatternLength

public int getMaximumPatternLength()

Get the maximum length of patterns to be found (in terms of item count)

Returns:

the maximumPatternLength

setMaximumPatternLength

public void setMaximumPatternLength(int maximumPatternLength)

Set the maximum length of patterns to be found (in terms of item count)

Parameters:

maximumPatternLength - the maximumPatternLength to set