NGramModelTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package opennlp.tools.ngram;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;

import org.junit.Assert;
import org.junit.Test;

import opennlp.tools.dictionary.Dictionary;
import opennlp.tools.util.InvalidFormatException;
import opennlp.tools.util.StringList;

/**
 * Tests for {@link opennlp.tools.ngram.NGramModel}
 */
public class NGramModelTest {

  @Test
  public void testZeroGetCount() throws Exception {
    NGramModel ngramModel = new NGramModel();
    int count = ngramModel.getCount(new StringList(""));
    Assert.assertEquals(0, count);
    Assert.assertEquals(0, ngramModel.size());
  }

  @Test
  public void testZeroGetCount2() throws Exception {
    NGramModel ngramModel = new NGramModel();
    ngramModel.add(new StringList("the", "bro", "wn"));
    int count = ngramModel.getCount(new StringList("fox"));
    Assert.assertEquals(0, count);
    Assert.assertEquals(1, ngramModel.size());
  }

  @Test
  public void testAdd() throws Exception {
    NGramModel ngramModel = new NGramModel();
    ngramModel.add(new StringList("the", "bro", "wn"));
    int count = ngramModel.getCount(new StringList("the"));
    Assert.assertEquals(0, count);
    Assert.assertEquals(1, ngramModel.size());
  }

  @Test
  public void testAdd1() throws Exception {
    NGramModel ngramModel = new NGramModel();
    ngramModel.add(new StringList("the", "bro", "wn"));
    int count = ngramModel.getCount(new StringList("the", "bro", "wn"));
    Assert.assertEquals(1, count);
    Assert.assertEquals(1, ngramModel.size());
  }

  @Test
  public void testAdd2() throws Exception {
    NGramModel ngramModel = new NGramModel();
    ngramModel.add(new StringList("the", "bro", "wn"), 2, 3);
    int count = ngramModel.getCount(new StringList("the", "bro", "wn"));
    Assert.assertEquals(1, count);
    Assert.assertEquals(3, ngramModel.size());
  }

  @Test
  public void testAdd3() throws Exception {
    NGramModel ngramModel = new NGramModel();
    ngramModel.add(new StringList("the", "brown", "fox"), 2, 3);
    int count = ngramModel.getCount(new StringList("the", "brown", "fox"));
    Assert.assertEquals(1, count);
    count = ngramModel.getCount(new StringList("the", "brown"));
    Assert.assertEquals(1, count);
    count = ngramModel.getCount(new StringList("brown", "fox"));
    Assert.assertEquals(1, count);
    Assert.assertEquals(3, ngramModel.size());
  }

  @Test
  public void testRemove() throws Exception {
    NGramModel ngramModel = new NGramModel();
    StringList tokens = new StringList("the", "bro", "wn");
    ngramModel.add(tokens);
    ngramModel.remove(tokens);
    Assert.assertEquals(0, ngramModel.size());
  }

  @Test
  public void testContains() throws Exception {
    NGramModel ngramModel = new NGramModel();
    StringList tokens = new StringList("the", "bro", "wn");
    ngramModel.add(tokens);
    Assert.assertFalse(ngramModel.contains(new StringList("the")));
  }

  @Test
  public void testContains2() throws Exception {
    NGramModel ngramModel = new NGramModel();
    StringList tokens = new StringList("the", "bro", "wn");
    ngramModel.add(tokens, 1, 3);
    Assert.assertTrue(ngramModel.contains(new StringList("the")));
  }

  @Test
  public void testNumberOfGrams() throws Exception {
    NGramModel ngramModel = new NGramModel();
    StringList tokens = new StringList("the", "bro", "wn");
    ngramModel.add(tokens, 1, 3);
    Assert.assertEquals(6, ngramModel.numberOfGrams());
  }

  @Test
  public void testCutoff1() throws Exception {
    NGramModel ngramModel = new NGramModel();
    StringList tokens = new StringList("the", "brown", "fox", "jumped");
    ngramModel.add(tokens, 1, 3);
    ngramModel.cutoff(2, 4);
    Assert.assertEquals(0, ngramModel.size());
  }

  @Test
  public void testCutoff2() throws Exception {
    NGramModel ngramModel = new NGramModel();
    StringList tokens = new StringList("the", "brown", "fox", "jumped");
    ngramModel.add(tokens, 1, 3);
    ngramModel.cutoff(1, 3);
    Assert.assertEquals(9, ngramModel.size());
  }

  @Test
  public void testToDictionary() throws Exception {
    NGramModel ngramModel = new NGramModel();
    StringList tokens = new StringList("the", "brown", "fox", "jumped");
    ngramModel.add(tokens, 1, 3);
    tokens = new StringList("the", "brown", "Fox", "jumped");
    ngramModel.add(tokens, 1, 3);
    Dictionary dictionary = ngramModel.toDictionary();
    Assert.assertNotNull(dictionary);
    Assert.assertEquals(9, dictionary.size());
    Assert.assertEquals(1, dictionary.getMinTokenCount());
    Assert.assertEquals(3, dictionary.getMaxTokenCount());
  }

  @Test
  public void testToDictionary1() throws Exception {
    NGramModel ngramModel = new NGramModel();
    StringList tokens = new StringList("the", "brown", "fox", "jumped");
    ngramModel.add(tokens, 1, 3);
    tokens = new StringList("the", "brown", "Fox", "jumped");
    ngramModel.add(tokens, 1, 3);
    Dictionary dictionary = ngramModel.toDictionary(true);
    Assert.assertNotNull(dictionary);
    Assert.assertEquals(14, dictionary.size());
    Assert.assertEquals(1, dictionary.getMinTokenCount());
    Assert.assertEquals(3, dictionary.getMaxTokenCount());
  }
  
  @Test(expected = InvalidFormatException.class)
  public void testInvalidFormat() throws Exception {
    InputStream stream = new ByteArrayInputStream("inputstring".getBytes(StandardCharsets.UTF_8));
    NGramModel ngramModel = new NGramModel(stream);
    stream.close();
    ngramModel.toDictionary(true);
  }
  
  @Test
  public void testFromFile() throws Exception {
    InputStream stream = getClass().getResourceAsStream("/opennlp/tools/ngram/ngram-model.xml");
    NGramModel ngramModel = new NGramModel(stream);
    stream.close();
    Dictionary dictionary = ngramModel.toDictionary(true);
    Assert.assertNotNull(dictionary);
    Assert.assertEquals(14, dictionary.size());
    Assert.assertEquals(3, dictionary.getMaxTokenCount());
    Assert.assertEquals(1, dictionary.getMinTokenCount());
  }
  
  @Test
  public void testSerialize() throws Exception {
   
    InputStream stream = getClass().getResourceAsStream("/opennlp/tools/ngram/ngram-model.xml");
    
    NGramModel ngramModel1 = new NGramModel(stream);
    stream.close();
    
    Dictionary dictionary = ngramModel1.toDictionary(true);
    Assert.assertNotNull(dictionary);
    Assert.assertEquals(14, dictionary.size());
    Assert.assertEquals(3, dictionary.getMaxTokenCount());
    Assert.assertEquals(1, dictionary.getMinTokenCount());
    
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    ngramModel1.serialize(baos);
    
    final String serialized = new String(baos.toByteArray(), Charset.defaultCharset());
    InputStream inputStream = new ByteArrayInputStream(serialized.getBytes(StandardCharsets.UTF_8));
        
    NGramModel ngramModel2 = new NGramModel(inputStream);
    stream.close();
        
    Assert.assertEquals(ngramModel2.numberOfGrams(), ngramModel2.numberOfGrams());
    Assert.assertEquals(ngramModel2.size(), ngramModel2.size());
    
    dictionary = ngramModel2.toDictionary(true);
    
    Assert.assertNotNull(dictionary);
    Assert.assertEquals(14, dictionary.size());
    Assert.assertEquals(3, dictionary.getMaxTokenCount());
    Assert.assertEquals(1, dictionary.getMinTokenCount());
    
  }
  
  @Test(expected = InvalidFormatException.class)
  public void testFromInvalidFileMissingCount() throws Exception {
    InputStream stream = getClass().getResourceAsStream("/opennlp/tools/ngram/ngram-model-no-count.xml");
    NGramModel ngramModel = new NGramModel(stream);
    stream.close();
    ngramModel.toDictionary(true);
  }
  
  @Test(expected = InvalidFormatException.class)
  public void testFromInvalidFileNotANumber() throws Exception {
    InputStream stream = getClass().getResourceAsStream("/opennlp/tools/ngram/ngram-model-not-a-number.xml");
    NGramModel ngramModel = new NGramModel(stream);
    stream.close();
    ngramModel.toDictionary(true);
  }

}