001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.pgm.util;
031
032import org.openimaj.feature.SparseIntFV;
033
034/**
035 * A document is a bag of words
036 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
037 *
038 */
039public class Document extends SparseIntFV{
040
041        /**
042         * 
043         */
044        private static final long serialVersionUID = 2073772149798865435L;
045        private int length;
046        
047        /**
048         * @param corpus documents from the same corpus share the same vocabulary size
049         */
050        public Document(Corpus corpus) {
051                super(corpus.vocabularySize());
052        }
053        
054        /**
055         * @param vocabularySize the number of words in this vocabulary
056         */
057        public Document(int vocabularySize) {
058                super(vocabularySize);
059        }
060        /**
061         * @return the number of unique words in this document
062         */
063        public int countUniqueWords(){
064                return this.getVector().used();
065        }
066        
067        
068        @Override
069        public int length(){
070                return this.length;
071        }
072        
073        /**
074         * sets a word in the document's count.
075         * @param word
076         * @param count
077         */
078        public void setWordCount(int word, int count){
079                if(this.getVector().isUsed(word)){
080                        this.length -= this.getVector().get(word);
081                }
082                this.length += this.getVector().set(word, count);
083        }
084
085        
086}