From 4d4986fd573f81515ebe21b7f5fa155fe8423933 Mon Sep 17 00:00:00 2001 From: tama3 Date: Sun, 13 May 2007 12:35:24 +0000 Subject: [PATCH] update javadocs git-svn-id: svn+ssh://svn.sourceforge.jp/svnroot/stigmata/trunk@113 acee48c3-7b26-0410-bdac-b3d0e5314bbc --- .../birthmarks/comparators/AbstractBirthmarkComparatorService.java | 2 +- .../birthmarks/comparators/DPMatchingBirthmarkComparator.java | 1 - .../comparators/DPMatchingBirthmarkComparatorService.java | 3 ++- .../comparators/EditDistanceBirthmarkComparatorService.java | 3 ++- .../comparators/ExtendedEditDistanceBirthmarkComparatorService.java | 3 ++- .../comparators/LogicalAndBirthmarkComparatorService.java | 3 ++- .../stigmata/birthmarks/comparators/PlainBirthmarkComparator.java | 6 ++++++ .../birthmarks/comparators/PlainBirthmarkComparatorService.java | 3 ++- 8 files changed, 17 insertions(+), 7 deletions(-) diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/AbstractBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/AbstractBirthmarkComparatorService.java index 94b5f26..84bc1e8 100755 --- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/AbstractBirthmarkComparatorService.java +++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/AbstractBirthmarkComparatorService.java @@ -15,7 +15,7 @@ import jp.naist.se.stigmata.spi.BirthmarkSpi; import jp.naist.se.stigmata.utils.LocalizedDescriptionManager; /** - * Birthmark Service Provider Interface. + * Abstract service provider interface for comparing birthmarks. * * @author Haruaki TAMADA * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $ diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparator.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparator.java index 5e625d9..cd857e1 100755 --- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparator.java +++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparator.java @@ -11,7 +11,6 @@ import jp.naist.se.stigmata.spi.BirthmarkSpi; /** * calculate similarities between two birthmarks by DP matching algorithm. - * * * @author Haruaki TAMADA * @version $Revision$ $Date$ diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparatorService.java index e658aa0..b0bdf31 100755 --- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparatorService.java +++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparatorService.java @@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator; import jp.naist.se.stigmata.spi.BirthmarkSpi; /** - * Birthmark Service Provider Interface. + * SPI of {@link BirthmarkComparator BirthmarkComparator}. + * Comparing birthmarks by DP matching algorithm. * * @author Haruaki TAMADA * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $ diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/EditDistanceBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/EditDistanceBirthmarkComparatorService.java index 3fc10d3..2dc0568 100755 --- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/EditDistanceBirthmarkComparatorService.java +++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/EditDistanceBirthmarkComparatorService.java @@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator; import jp.naist.se.stigmata.spi.BirthmarkSpi; /** - * Birthmark Service Provider Interface. + * SPI of {@link BirthmarkComparator BirthmarkComparator}. + * Comparing birthmarks by edit distance algorithm. * * @author Haruaki TAMADA * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $ diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/ExtendedEditDistanceBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/ExtendedEditDistanceBirthmarkComparatorService.java index 88ca9eb..3219ae5 100755 --- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/ExtendedEditDistanceBirthmarkComparatorService.java +++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/ExtendedEditDistanceBirthmarkComparatorService.java @@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator; import jp.naist.se.stigmata.spi.BirthmarkSpi; /** - * Birthmark Service Provider Interface. + * SPI of {@link BirthmarkComparator BirthmarkComparator}. + * Comparing birthmarks by extended edit distance algorithm. * * @author Haruaki TAMADA * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $ diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/LogicalAndBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/LogicalAndBirthmarkComparatorService.java index 24b537a..032741e 100755 --- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/LogicalAndBirthmarkComparatorService.java +++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/LogicalAndBirthmarkComparatorService.java @@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator; import jp.naist.se.stigmata.spi.BirthmarkSpi; /** - * Birthmark Service Provider Interface. + * SPI of {@link BirthmarkComparator BirthmarkComparator}. + * Comparing birthmarks by logical AND algorithm. * * @author Haruaki TAMADA * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $ diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparator.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparator.java index 9c269ee..4057830 100755 --- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparator.java +++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparator.java @@ -10,6 +10,12 @@ import jp.naist.se.stigmata.BirthmarkElement; import jp.naist.se.stigmata.spi.BirthmarkSpi; /** + * An implementation of {@link BirthmarkComparator + * BirthmarkComparator}. Let p and q be + * programs, f(p) and f(q) be extracted birthmarks from + * p and q. Let |f(p)| be a element count of + * f(p). Then, expression of comparing birthmarks algorithm of + * this class is defined as |f(p) and f(q)|/(|f(p)| + |f(q)|). * * @author Haruaki TAMADA * @version $Revision$ $Date$ diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparatorService.java index ea53a83..29ee199 100755 --- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparatorService.java +++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparatorService.java @@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator; import jp.naist.se.stigmata.spi.BirthmarkSpi; /** - * Birthmark Service Provider Interface. + * SPI of {@link BirthmarkComparator BirthmarkComparator}. + * Comparing birthmarks by default matching algorithm. * * @author Haruaki TAMADA * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $ -- 2.11.0