Ignore:
Timestamp:
07/18/16 13:44:58 (8 years ago)
Author:
sherbold
Message:
  • more code documentation
Location:
trunk/CrossPare/src/de/ugoe/cs/cpdp
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/ExperimentConfiguration.java

    r135 r136  
    188188     * Constructor. Creates a new configuration from a given file. 
    189189     *  
    190      * @param filename 
     190     * @param file 
    191191     *            handle of the file from the configuration is loaded. 
    192192     * @throws ExperimentConfigurationException 
    … …  
    414414    } 
    415415 
     416    /** 
     417     * <p> 
     418     * returns the result storages 
     419     * </p> 
     420     * 
     421     * @return result storages 
     422     */ 
    416423    public List<IResultStorage> getResultStorages() { 
    417424        return resultStorages; 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/dataprocessing/NormalizationUtil.java

    r86 r136  
    137137     * @param testdata 
    138138     *            test data of the target product 
    139      * @param traindata 
     139     * @param traindataSet 
    140140     *            training data 
    141141     */ 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/decentApp/DECENTEpsilonModelHandler.java

    r86 r136  
    4242    private boolean useARFFxBinary = false; 
    4343 
     44    /** 
     45     * path for DECENT model meta data 
     46     */ 
    4447    public static String metaPath = "./decent/models/"; 
    4548 
    … …  
    300303     * @param fileName 
    301304     *            of the file 
    302      * @return 
     305     * @return file name 
    303306     * @throws URISyntaxException 
    304307     */ 
    … …  
    337340     * Returns true if decent binary model is used 
    338341     *  
    339      * @return 
     342     * @return true if binary 
    340343     */ 
    341344 
    … …  
    356359     * Returns true if arffx binary model is used 
    357360     *  
    358      * @return 
     361     * @return true if ARFFx 
    359362     */ 
    360363    public boolean isUseARFFxBinary() { 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/decentApp/ResourceTool.java

    r86 r136  
    120120 
    121121    /** 
    122      * Loads a ressource from XMI 
     122     * Loads a resource from XMI 
    123123     *  
    124124     * @param inputPath 
    125125     *            path to the xmi 
    126126     * @param extension 
    127      *            of the ressource to load 
     127     *            of the resource to load 
    128128     * @param p 
    129129     *            the given EPackage 
    130      * @return 
     130     * @return the resource 
    131131     */ 
    132132    // TODO: workarounds copied from respective methods without EPackage parameter 
    … …  
    156156 
    157157    /** 
    158      * Loads a ressource from XMI 
     158     * Loads a resource from XMI 
    159159     *  
    160160     * @param inputPath 
    … …  
    162162     * @param extension 
    163163     *            of the ressource to load 
    164      * @return 
     164     * @return the resource 
    165165     */ 
    166166 
    … …  
    187187 
    188188    /** 
    189      * Gets a ressource from a binary form 
     189     * Gets a resource from a binary form 
    190190     *  
    191191     * @param inputPath 
    … …  
    194194     *            of the model to load 
    195195     * @param p 
    196      *            EPackage to put the loaded ressource in 
    197      * @return 
     196     *            EPackage to put the loaded resource in 
     197     * @return the resource 
    198198     */ 
    199199    public Resource getResourceFromBinary(String inputPath, String extension, EPackage p) { 
    … …  
    218218 
    219219    /** 
    220      * Loads a ressource from a binary form 
     220     * Loads a resource from a binary form 
    221221     *  
    222222     * @param inputPath 
    … …  
    225225     *            of the model to load 
    226226     * @param p 
    227      *            EPackage to put the loaded ressource in 
    228      * @return 
     227     *            EPackage to put the loaded resource in 
     228     * @return the resource 
    229229     */ 
    230230    // TODO: workarounds copied from respective methods without EPackage parameter 
    … …  
    266266 
    267267    /** 
    268      * Loads a ressource from a binary form 
     268     * Loads a resource from a binary form 
    269269     *  
    270270     * @param inputPath 
    … …  
    272272     * @param extension 
    273273     *            of the model to load 
    274      * @return 
     274     * @return the resource 
    275275     */ 
    276276    @SuppressWarnings( 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/eval/IEvaluationStrategy.java

    r132 r136  
    3838     * @param trainers 
    3939     *            list of training algorithms used to train the classifiers 
     40     * @param efforts 
     41     *            list with review efforts for each instance 
    4042     * @param writeHeader 
    4143     *            if true, a header line for the results file is written (may not be applicable) 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/DecentDataLoader.java

    r135 r136  
    403403     * Returns if a filename ends with ".decent" 
    404404     *  
    405      * @return 
     405     * @return true if a .decent file 
    406406     */ 
    407407    @Override 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/SingleVersionLoader.java

    r86 r136  
    3939     * considered. 
    4040     *  
    41      * @param filename 
     41     * @param endsWith 
    4242     *            string defining the filename filter 
    4343     * @return true if a filename shall be considered 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/training/GPTraining.java

    r135 r136  
    249249         * </p> 
    250250         * 
    251          * @return 
     251         * @return the instance values 
    252252         */ 
    253253        public double[][] getX() { 
    … …  
    260260         * </p> 
    261261         * 
    262          * @return 
     262         * @return the instance labels 
    263263         */ 
    264264        public boolean[] getY() { 
    … …  
    450450             * @param populationSize 
    451451             *            the population size 
    452              * @param initMinDepth 
     452             * @param minInitDept 
    453453             *            the initial minimal depth of the S-expression tree 
    454              * @param initMaxDepth 
     454             * @param maxInitDepth 
    455455             *            the initial maximal depth of the S-expression tree 
    456456             * @param tournamentSize 
    … …  
    12651265         * @param evalData 
    12661266         *            the validation data 
    1267          * @return 
     1267         * @return the type I and type II error rates 
    12681268         */ 
    12691269        public double[] evaluate(GPRun classifier, Instances evalData) { 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/training/QuadTree.java

    r135 r136  
    525525     * </ol> 
    526526     *  
    527      * @param q 
     527     * @param list 
    528528     *            List of QuadTree (children only) 
    529529     */ 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/training/WekaLocalFQTraining.java

    r135 r136  
    574574     *  
    575575     * @author Alexander Trautsch 
     576     * @param <T> type of the instance 
    576577     */ 
    577578    public class QuadTreePayload<T> { 
    … …  
    615616         * </p> 
    616617         * 
    617          * @return 
     618         * @return the instance 
    618619         */ 
    619620        public T getInst() { 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/util/WekaUtils.java

    r135 r136  
    3838     */ 
    3939    public static class DistChar { 
     40         
     41        /** 
     42         * mean distance 
     43         */ 
    4044        public final double mean; 
     45         
     46        /** 
     47         * standard deviation 
     48         */ 
    4149        public final double std; 
     50         
     51        /** 
     52         * minimal value 
     53         */ 
    4254        public final double min; 
     55         
     56        /** 
     57         * maximal value 
     58         */ 
    4359        public final double max; 
     60         
     61        /** 
     62         * number of instances 
     63         */ 
    4464        public final int num; 
    4565 
     66        /** 
     67         * <p> 
     68         * Constructor. Creates a new DistChar object.  
     69         * </p> 
     70         * 
     71         * @param mean mean distance between instances 
     72         * @param std standard deviation of distances between instances 
     73         * @param min minimal distance between instances 
     74         * @param max maximal distance between instances 
     75         * @param num number of instance 
     76         */ 
    4677        private DistChar(double mean, double std, double min, double max, int num) { 
    4778            this.mean = mean; 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/versions/SoftwareVersion.java

    r135 r136  
    5555     * @param instances 
    5656     *            data of the version 
     57     * @param efforts 
     58     *            review efforts for the version 
    5759     */ 
    5860    public SoftwareVersion(String project, 
    … …  
    99101     * </p> 
    100102     * 
    101      * @return 
     103     * @return the review efforts 
    102104     */ 
    103105    public List<Double> getEfforts() { 

  • trunk/CrossPare/src/de/ugoe/cs/cpdp/wekaclassifier/WHICH.java

    r135 r136  
    363363         * </p> 
    364364         * 
    365          * @return 
     365         * @return the score 
    366366         */ 
    367367        public double getScore() { 
    … …  
    532532         * </p> 
    533533         * 
    534          * @return 
     534         * @return drawn rule 
    535535         */ 
    536536        public WhichRule drawRule() { 
Note: See TracChangeset for help on using the changeset viewer.