Interface VariableMapping

src/com/winvector/variables/VariableMapping.java:8–83

import com.winvector.util.BurstMap;

public interface VariableMapping extends Serializable {
	
	/**
	 * 
	 * @return name of original column
	 */
	String origColumn();
	
	/**
	 * 
	 * @return left index (inclusive) of interval encoding to
	 */
	int indexL();
	
	
	/**
	 * 
	 * @return right index (exclusive) of interval encoding to
	 */
	int indexR();


	/**
	 * 
	 * @return true if want regularization (all but const terms should set this)
	 */
	boolean wantRegularization();

	/**
	 * Take data from row and paste into vec
	 * @param row
	 * @param vec
	 */
	void process(BurstMap row, double[] vec);

	/**
	 * type of adaption
	 * @return
	 */
	String name();

	/**
	 * 
	 * @param base how many indices to skip (use to get per-outcome data, so base will be a multiple of encoding dimension)
	 * @param x vector soln.
	 * @return effect this variable has at each level ("" for unique level) 
	 */
	SortedMap<String,Double> effects(int base, double[] x);
	
	/**
	 * 
	 * @param base how many indices to skip (use to get per-outcome data, so base will be a multiple of encoding dimension)
	 * @param x vector soln
	 * @return map similar to effects, possibly with additional entries for pseudo-levels (to carry more detail)
	 */
	SortedMap<String, Double> detailedEffects(int base, double[] x);
	
	/**