rortega.cf4j-recsys.1.1.0.source-code.TestUser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cf4j-recsys Show documentation
A Java's Collaborative Filtering library to carry out experiments in research of Collaborative Filtering based Recommender Systems. The library has been designed from researchers to researchers.
The newest version!
package cf4j;

import cf4j.utils.Methods;

/**
 * A TestUser extends an User given it the following properties:
 * 
 *  User index in the test users array
 *  Array of test items that the user have rated
 *  Array of test ratings hat the user have made
 * 
 * @author Fernando Ortega
 */
public class TestUser extends User {

	private static final long serialVersionUID = 20130403L;
	
	private final static String SIMILARITIES_KEY = "similarities";
	private final static String NEIGHBORS_KEY = "neighbors";
	private final static String PREDICTIONS_KEYS = "predictions";

	/**
	 * Test user index
	 */
	protected int testUserIndex;
	
	/**
	 * Test items that rated by the user
	 */
	protected int [] testItems;
	
	/**
	 * Test ratings of the items
	 */
	protected double [] testRatings;
	
	/**
	 * Test rating average of the user
	 */
	protected double testRatingAverage;
	
	/**
	 * Test rating standard deviation of this user
	 */
	protected double testRatingStandardDeviation;
	
	/**
	 * Creates a new instance of an user. This constructor should not be used by developers.
	 * @param userCode User code
	 * @param userIndex User index
	 * @param items Items that the user have rated
	 * @param ratings Ratings of the user to the items
	 * @param testUserIndex Test user index
	 * @param testItems Test items that the user have rated
	 * @param testRatings Test ratings of the user to the items
	 */
	public TestUser (int userCode, int userIndex, int [] items, double [] ratings, int testUserIndex, int [] testItems, double [] testRatings) {
		super(userCode, userIndex, items, ratings);
		this.testUserIndex = testUserIndex;
		this.testItems = testItems;
		this.testRatings = testRatings;
		this.testRatingAverage = Methods.arrayAverage(testRatings);
		this.testRatingStandardDeviation = Methods.arrayStandardDeviation(testRatings);
	}
	
	/**
	 * Average of the test ratings
	 * @return Test rating average
	 */
	public double getTestRatingAverage() {
		return this.testRatingAverage;
	}

	/**
	 * Standard deviation of the test ratings
	 * @return Test rating standard deviation
	 */
	public double getTestRatingStandardDeviation() {
		return this.testRatingStandardDeviation;
	}
	
	/**
	 * Return the test user index
	 * @return Test user index
	 */
	public int getTestUserIndex() {
		return this.testUserIndex;
	}
	
	/**
	 * Get the test items rated by the user
	 * @return Test items codes sorted from low to high. 
	 */
	public int [] getTestItems() {
		return this.testItems;
	}

	/**
	 * Get the ratings of the test items. The indexes of this array overlaps
	 * with indexes of the getTestItems() array.
	 * @return Test items ratings
	 */
	public double [] getTestRatings() {
		return this.testRatings;
	}
	
	/**
	 * Get the index of an test item code at the test items array of the user.
	 * @param item_code Item code
	 * @return Test item index if the user has rated the item or -1 if not
	 */
	public int getTestItemIndex (int item_code) {
		return Methods.getIndex(this.testItems, item_code);
	}
	
	/**
	 * Get the number of test ratings of the user.
	 * @return Number of test ratings made
	 */
	public int getNumberOfTestRatings () {
		return this.testRatings.length;
	}
	
	/**
	 * Return the similarities array of the test user. The similarity process must be 
	 * executed before use this method.
	 * @return Similarities array or null
	 */
	public double [] getSimilarities () {
		return (double []) this.get(SIMILARITIES_KEY);
	}
	
	/**
	 * Set the similarity of this user with the training users. The positions of the
	 * similarities arrays must overlaps with the positions of the users of the method
	 * Kernel.getUsers().
	 * @param similarities Similarities array. Higher is more similar.
	 */
	public void setSimilarities (double [] similarities) {
		this.put(SIMILARITIES_KEY, similarities);
	}
	
	/**
	 * Return the neighbors array of the test user. The neighbors process must be executed
	 * before use this method.
	 * @return Neighbors array or null
	 */
	public int [] getNeighbors () {
		return (int []) this.get(NEIGHBORS_KEY);
	}
	
	/**
	 * Set the users indexes that are neighbors of the user. First positions of the neighbors
	 * array must be most similar users.
	 * @param neighbors User indexes that are neighbors of this user sorted by similarity
	 */
	public void setNeighbors (int [] neighbors) {
		this.put(NEIGHBORS_KEY, neighbors);
	}
	
	/**
	 * Return the predictions array of the test user. The prediction process must be 
	 * executed before use this method.
	 * @return Similarities array or null
	 */
	public double [] getPredictions () {
		return (double []) this.get(PREDICTIONS_KEYS);
	}
	
	/**
	 * Set rating prediction for the test items of this user. Predictions array positions must
	 * overlap with items returned by this.getTestItems().
	 * @param predictions Predictions of test items
	 */
	public void setPredictions (double [] predictions) {
		this.put(PREDICTIONS_KEYS, predictions);
	}
}