ca.pfv.spmf.algorithms.sequentialpatterns.spam

Class AlgoVGEN

java.lang.Object

ca.pfv.spmf.algorithms.sequentialpatterns.spam.AlgoVGEN

public class AlgoVGEN
extends java.lang.Object

* This is an implementation of the VGEN algorithm.

Copyright (c) 2014 Philippe Fournier-Viger, Antonio Gomariz

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 .

See Also:

Bitmap, PrefixVGEN, PatternVGEN

Field Summary

Fields

Modifier and Type	Field and Description
long	endTime
int	patternCount
long	startTime

Constructor Summary

Constructors

Constructor and Description
AlgoVGEN() Default constructor

Method Summary

Modifier and Type	Method and Description
int	getMaximumPatternLength() Get the maximum length of patterns to be found (in terms of itemset count)
void	printStatistics() Print the statistics of the algorithm execution to System.out.
java.util.List<java.util.Map<java.lang.Integer,java.util.List<PatternVGEN>>>	runAlgorithm(java.lang.String input, java.lang.String outputFilePath, double minsupRel) Method to run the algorithm
void	setMaximumPatternLength(int maximumPatternLength) Set the maximum length of patterns to be found (in terms of itemset count)
void	writeResultTofile(java.lang.String path) Write the result to an output file

Methods inherited from class java.lang.Object

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

Field Detail

startTime

public long startTime

endTime

public long endTime

patternCount

public int patternCount

Constructor Detail

AlgoVGEN

public AlgoVGEN()

Default constructor

Method Detail

runAlgorithm

public java.util.List<java.util.Map<java.lang.Integer,java.util.List<PatternVGEN>>> runAlgorithm(java.lang.String input,
                                                                                                 java.lang.String outputFilePath,
                                                                                                 double minsupRel)
                                                                                          throws java.io.IOException

Method to run the algorithm

Parameters:

input - path to an input file

outputFilePath - path for writing the output file

minsupRel - the minimum support as a relative value

Returns:

Throws:

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

printStatistics

public void printStatistics()

Print the statistics of the algorithm execution to System.out.

getMaximumPatternLength

public int getMaximumPatternLength()

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

Returns:

the maximumPatternLength

setMaximumPatternLength

public void setMaximumPatternLength(int maximumPatternLength)

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

Parameters:

maximumPatternLength - the maximumPatternLength to set

writeResultTofile

public void writeResultTofile(java.lang.String path)
                       throws java.io.IOException

Write the result to an output file

Parameters:

path - the output file path

Throws:

java.io.IOException - exception if an error occur when writing the file.