// Path: src/com/structed/models/ClassifierData.java
// public class ClassifierData {
// 
//     public ITaskLoss taskLoss;
//     public IUpdateRule updateRule;
//     public IInference inference;
//     public IKernel kernel;
//     public IFeatureFunctions phi;
//     public List<Double> arguments;
//     public int iteration = 0;
//     public String verbose = "";
// }
// 
// Path: src/com/structed/data/entities/Example.java
// public abstract class Example {
// 
//     public String path;
//     private String label;
//     private int fold;
//     public int sizeOfVector;
// 
// 	//C'tor
// 	public Example() {
//         label = "";
//         sizeOfVector = 0;
// 	}
// 
// 	//===========GETTERS AND SETTERS=========//
// 	public Vector getFeatures(){return null;}
// 	public void setFeatures(Vector features){}
// 
//     public ArrayList<Vector> getFeatures2D(){return null;}
//     public void setFeatures2D(ArrayList<Vector> features){}
//     public ArrayList<Integer> getLabels2D(){return null;}
//     public void setLabels2D(ArrayList<Integer> rankLabels){}
// 
//     public String getLabel() {
//         return label;
//     }
//     public void setLabel(String label) {
//         this.label = label;
//     }
// 
//     public int getFold() { return fold; }
//     public void setFold(int fold) { this.fold = fold; }
// }
// 
// Path: src/com/structed/data/entities/Vector.java
// public class Vector extends HashMap<Integer, Double> implements Serializable{
// 
//     private static final long serialVersionUID = 1L;
//     private int maxIndex;
//     public Vector(){this.maxIndex = -1;}
//     public Vector(Vector v){
//         super(v);
//     }
// 
//     @Override
//     public Double put(Integer key, Double value){
//         super.put(key, value);
//         if(maxIndex < key) maxIndex = key;
//         return value;
//     }
// 
//     // getter
//     public int getMaxIndex() {
//         return maxIndex;
//     }
//     public void resetMaxIndex(){
//         this.maxIndex = -1;
//     }
// }


import java.util.ArrayList;
import com.structed.models.ClassifierData;
import com.structed.data.entities.Example;
import com.structed.data.entities.Vector;
/*
 * The MIT License (MIT)
 *
 * StructED - Machine Learning Package for Structured Prediction
 *
 * Copyright (c) 2015 Yossi Adi, E-Mail: yossiadidrum@gmail.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.structed.models.algorithms;



/**
 * IUpdateRule interface - inorder to add new update rule in you own task you should implement this interface
 * this interface enable us to set many update versions and compare between them
 */
public interface IUpdateRule {
	//the arguments would be different from update to update
	Vector update(Vector currentWeights, Example example, ClassifierData classifierData);
// Path: src/com/structed/models/ClassifierData.java
// public class ClassifierData {
// 
//     public ITaskLoss taskLoss;
//     public IUpdateRule updateRule;
//     public IInference inference;
//     public IKernel kernel;
//     public IFeatureFunctions phi;
//     public List<Double> arguments;
//     public int iteration = 0;
//     public String verbose = "";
// }
// 
// Path: src/com/structed/data/entities/Example.java
// public abstract class Example {
// 
//     public String path;
//     private String label;
//     private int fold;
//     public int sizeOfVector;
// 
// 	//C'tor
// 	public Example() {
//         label = "";
//         sizeOfVector = 0;
// 	}
// 
// 	//===========GETTERS AND SETTERS=========//
// 	public Vector getFeatures(){return null;}
// 	public void setFeatures(Vector features){}
// 
//     public ArrayList<Vector> getFeatures2D(){return null;}
//     public void setFeatures2D(ArrayList<Vector> features){}
//     public ArrayList<Integer> getLabels2D(){return null;}
//     public void setLabels2D(ArrayList<Integer> rankLabels){}
// 
//     public String getLabel() {
//         return label;
//     }
//     public void setLabel(String label) {
//         this.label = label;
//     }
// 
//     public int getFold() { return fold; }
//     public void setFold(int fold) { this.fold = fold; }
// }
// 
// Path: src/com/structed/data/entities/Vector.java
// public class Vector extends HashMap<Integer, Double> implements Serializable{
// 
//     private static final long serialVersionUID = 1L;
//     private int maxIndex;
//     public Vector(){this.maxIndex = -1;}
//     public Vector(Vector v){
//         super(v);
//     }
// 
//     @Override
//     public Double put(Integer key, Double value){
//         super.put(key, value);
//         if(maxIndex < key) maxIndex = key;
//         return value;
//     }
// 
//     // getter
//     public int getMaxIndex() {
//         return maxIndex;
//     }
//     public void resetMaxIndex(){
//         this.maxIndex = -1;
//     }
// }


// Path: src/com/structed/models/algorithms/IUpdateRule.java
import java.util.ArrayList;
import com.structed.models.ClassifierData;
import com.structed.data.entities.Example;
import com.structed.data.entities.Vector;

/*
 * The MIT License (MIT)
 *
 * StructED - Machine Learning Package for Structured Prediction
 *
 * Copyright (c) 2015 Yossi Adi, E-Mail: yossiadidrum@gmail.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.structed.models.algorithms;



/**
 * IUpdateRule interface - inorder to add new update rule in you own task you should implement this interface
 * this interface enable us to set many update versions and compare between them
 */
public interface IUpdateRule {
	//the arguments would be different from update to update
	Vector update(Vector currentWeights, Example example, ClassifierData classifierData);
	void init(ArrayList<Double> args);