lucene-java-3.5.0/lucene/contrib/analyzers/stempel/src/java/org/egothor/stemmer/Optimizer.java

   1 /*
   2                     Egothor Software License version 1.00
   3                     Copyright (C) 1997-2004 Leo Galambos.
   4                  Copyright (C) 2002-2004 "Egothor developers"
   5                       on behalf of the Egothor Project.
   6                              All rights reserved.
   7
   8    This  software  is  copyrighted  by  the "Egothor developers". If this
   9    license applies to a single file or document, the "Egothor developers"
  10    are the people or entities mentioned as copyright holders in that file
  11    or  document.  If  this  license  applies  to the Egothor project as a
  12    whole,  the  copyright holders are the people or entities mentioned in
  13    the  file CREDITS. This file can be found in the same location as this
  14    license in the distribution.
  15
  16    Redistribution  and  use  in  source and binary forms, with or without
  17    modification, are permitted provided that the following conditions are
  18    met:
  19     1. Redistributions  of  source  code  must retain the above copyright
  20        notice, the list of contributors, this list of conditions, and the
  21        following disclaimer.
  22     2. Redistributions  in binary form must reproduce the above copyright
  23        notice, the list of contributors, this list of conditions, and the
  24        disclaimer  that  follows  these  conditions  in the documentation
  25        and/or other materials provided with the distribution.
  26     3. The name "Egothor" must not be used to endorse or promote products
  27        derived  from  this software without prior written permission. For
  28        written permission, please contact Leo.G@seznam.cz
  29     4. Products  derived  from this software may not be called "Egothor",
  30        nor  may  "Egothor"  appear  in  their name, without prior written
  31        permission from Leo.G@seznam.cz.
  32
  33    In addition, we request that you include in the end-user documentation
  34    provided  with  the  redistribution  and/or  in the software itself an
  35    acknowledgement equivalent to the following:
  36    "This product includes software developed by the Egothor Project.
  37     http://egothor.sf.net/"
  38
  39    THIS  SOFTWARE  IS  PROVIDED  ``AS  IS''  AND ANY EXPRESSED OR IMPLIED
  40    WARRANTIES,  INCLUDING,  BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  41    MERCHANTABILITY  AND  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  42    IN  NO  EVENT  SHALL THE EGOTHOR PROJECT OR ITS CONTRIBUTORS BE LIABLE
  43    FOR   ANY   DIRECT,   INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR
  44    CONSEQUENTIAL  DAMAGES  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  45    SUBSTITUTE  GOODS  OR  SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR
  46    BUSINESS  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  47    WHETHER  IN  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  48    OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  49    IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  50
  51    This  software  consists  of  voluntary  contributions  made  by  many
  52    individuals  on  behalf  of  the  Egothor  Project  and was originally
  53    created by Leo Galambos (Leo.G@seznam.cz).
  54  */
  55 package org.egothor.stemmer;
  56
  57 import java.util.ArrayList;
  58 import java.util.Arrays;
  59 import java.util.Iterator;
  60 import java.util.List;
  61
  62 /**
  63  * The Optimizer class is a Trie that will be reduced (have empty rows removed).
  64  * <p>
  65  * The reduction will be made by joining two rows where the first is a subset of
  66  * the second.
  67  */
  68 public class Optimizer extends Reduce {
  69   /**
  70    * Constructor for the Optimizer object.
  71    */
  72   public Optimizer() {}
  73
  74   /**
  75    * Optimize (remove empty rows) from the given Trie and return the resulting
  76    * Trie.
  77    *
  78    * @param orig the Trie to consolidate
  79    * @return the newly consolidated Trie
  80    */
  81   @Override
  82   public Trie optimize(Trie orig) {
  83     List<CharSequence> cmds = orig.cmds;
  84     List<Row> rows = new ArrayList<Row>();
  85     List<Row> orows = orig.rows;
  86     int remap[] = new int[orows.size()];
  87
  88     for (int j = orows.size() - 1; j >= 0; j--) {
  89       Row now = new Remap(orows.get(j), remap);
  90       boolean merged = false;
  91
  92       for (int i = 0; i < rows.size(); i++) {
  93         Row q = merge(now, rows.get(i));
  94         if (q != null) {
  95           rows.set(i, q);
  96           merged = true;
  97           remap[j] = i;
  98           break;
  99         }
 100       }
 101
 102       if (merged == false) {
 103         remap[j] = rows.size();
 104         rows.add(now);
 105       }
 106     }
 107
 108     int root = remap[orig.root];
 109     Arrays.fill(remap, -1);
 110     rows = removeGaps(root, rows, new ArrayList<Row>(), remap);
 111
 112     return new Trie(orig.forward, remap[root], cmds, rows);
 113   }
 114
 115   /**
 116    * Merge the given rows and return the resulting Row.
 117    *
 118    * @param master the master Row
 119    * @param existing the existing Row
 120    * @return the resulting Row, or <tt>null</tt> if the operation cannot be
 121    *         realized
 122    */
 123   public Row merge(Row master, Row existing) {
 124     Iterator<Character> i = master.cells.keySet().iterator();
 125     Row n = new Row();
 126     for (; i.hasNext();) {
 127       Character ch = i.next();
 128       // XXX also must handle Cnt and Skip !!
 129       Cell a = master.cells.get(ch);
 130       Cell b = existing.cells.get(ch);
 131
 132       Cell s = (b == null) ? new Cell(a) : merge(a, b);
 133       if (s == null) {
 134         return null;
 135       }
 136       n.cells.put(ch, s);
 137     }
 138     i = existing.cells.keySet().iterator();
 139     for (; i.hasNext();) {
 140       Character ch = i.next();
 141       if (master.at(ch) != null) {
 142         continue;
 143       }
 144       n.cells.put(ch, existing.at(ch));
 145     }
 146     return n;
 147   }
 148
 149   /**
 150    * Merge the given Cells and return the resulting Cell.
 151    *
 152    * @param m the master Cell
 153    * @param e the existing Cell
 154    * @return the resulting Cell, or <tt>null</tt> if the operation cannot be
 155    *         realized
 156    */
 157   public Cell merge(Cell m, Cell e) {
 158     Cell n = new Cell();
 159
 160     if (m.skip != e.skip) {
 161       return null;
 162     }
 163
 164     if (m.cmd >= 0) {
 165       if (e.cmd >= 0) {
 166         if (m.cmd == e.cmd) {
 167           n.cmd = m.cmd;
 168         } else {
 169           return null;
 170         }
 171       } else {
 172         n.cmd = m.cmd;
 173       }
 174     } else {
 175       n.cmd = e.cmd;
 176     }
 177     if (m.ref >= 0) {
 178       if (e.ref >= 0) {
 179         if (m.ref == e.ref) {
 180           if (m.skip == e.skip) {
 181             n.ref = m.ref;
 182           } else {
 183             return null;
 184           }
 185         } else {
 186           return null;
 187         }
 188       } else {
 189         n.ref = m.ref;
 190       }
 191     } else {
 192       n.ref = e.ref;
 193     }
 194     n.cnt = m.cnt + e.cnt;
 195     n.skip = m.skip;
 196     return n;
 197   }
 198 }