ostrich.automata.AutDatabase.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ostrich_2.12 Show documentation
OSTRICH is an SMT solver for string constraints.
The newest version!
/**
 * This file is part of Ostrich, an SMT solver for strings.
 * Copyright (c) 2020-2021 Philipp Ruemmer. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * 
 * * Neither the name of the authors nor the names of their
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package ostrich.automata

import ostrich.OstrichStringTheory

import ap.parser._

import scala.collection.mutable.{HashMap => MHashMap}

object AutDatabase {

  abstract sealed class NamedAutomaton (val id : Int) {
    def complement : NamedAutomaton
  }

  case class PositiveAut    (_id : Int) extends NamedAutomaton (_id) {
    def complement = ComplementedAut(id)
  }

  case class ComplementedAut(_id : Int) extends NamedAutomaton (_id) {
    def complement = PositiveAut(id)
  }

}

/**
 * A database to store the automata or transducers obtained from
 * regular expressions. The database will assign a unique id to regular
 * expressions, and will compute the resulting automaton on demand.
 */
class AutDatabase(theory : OstrichStringTheory,
                  minimizeAutomata : Boolean) {

  import AutDatabase._

  protected val regex2Aut  = new Regex2Aut(theory)

  private var nextId     = 0

  val regexes    = new MHashMap[ITerm, Int]
  val id2Regex   = new MHashMap[Int, ITerm]
  val id2Aut     = new MHashMap[Int, Automaton]
  val id2CompAut = new MHashMap[Int, Automaton]

  private val subsetRel  =
    new MHashMap[(NamedAutomaton, NamedAutomaton), Boolean]

  /**
   * Query the id of a regular expression.
   */
  def regex2Id(regexTerm : ITerm) : Int =
    synchronized {
      regexes.getOrElseUpdate(regexTerm, {
                                val id = nextId
                                nextId = nextId + 1
                                id2Regex.put(id, regexTerm)
                                id })
    }

  /**
   * Add a new automaton to the database.
   */
  def automaton2Id(aut : Automaton) : Int =
    synchronized {
      val id = nextId
      nextId = nextId + 1
      id2Aut.put(id, aut)
      id
    }

  /**
   * Query the id of a regular expression.
   */
  def id2Regex(id : Int) : Option[ITerm] =
    synchronized {
      id2Regex get id
    }

  /**
   * Query the automaton that belongs to the regular expression with given id.
   */
  def id2Automaton(id : Int) : Option[Automaton] =
    synchronized {
      (id2Aut get id) match {
        case r@Some(_) => r
        case None =>
          (id2Regex get id) match {
            case Some(regex) => {
              val aut = regex2Aut.buildAut(regex, minimizeAutomata)
              id2Aut.put(id, aut)
              Some(aut)
            }
            case None =>
              None
          }
      }
    }

  /**
   * Query the automaton that belongs to the regular expression with given id;
   * return the automaton only if it is already in the database.
   */
  def id2AutomatonBE(id : Int) : Option[Automaton] =
    synchronized { id2Aut get id }

  /**
   * Query the complemented automaton that belongs to the regular
   * expression with given id.
   */
  def id2ComplementedAutomaton(id : Int) : Option[Automaton] =
    synchronized {
      (id2CompAut get id) match {
        case r@Some(_) => r
        case None =>
          id2Automaton(id) match {
            case Some(aut) => {
              val compAut = !aut
              id2CompAut.put(id, compAut)
              Some(compAut)
            }
            case None =>
              None
          }
      }
    }

  /**
   * Query the complemented automaton that belongs to the regular
   * expression with given id;
   * return the automaton only if it is already in the database.
   */
  def id2ComplementedAutomatonBE(id : Int) : Option[Automaton] =
    synchronized { id2CompAut get id }

  /**
   * Query the automaton that belongs to the regular expression with
   * given id.
   */
  def id2Automaton(id : NamedAutomaton) : Option[Automaton] = id match {
    case PositiveAut(id)     => id2Automaton(id)
    case ComplementedAut(id) => id2ComplementedAutomaton(id)
  }

  /**
   * Query the automaton that belongs to the regular expression with
   * given id;
   * return the automaton only if it is already in the database.
   */
  def id2AutomatonBE(id : NamedAutomaton) : Option[Automaton] = id match {
    case PositiveAut(id)     => id2AutomatonBE(id)
    case ComplementedAut(id) => id2ComplementedAutomatonBE(id)
  }

  /**
   * Check whether aut1 specifies a subset of aut2.
   */
  def isSubsetOf(aut1 : NamedAutomaton, aut2 : NamedAutomaton) : Boolean =
    if (aut1.id < aut2.id) {
      synchronized {
        // aut1 <= aut2
        //  <==>
        // (aut1 & aut2.complement) = empty
        subsetRel.getOrElseUpdate((aut1, aut2),
                                  !AutomataUtils.areConsistentAutomata(
                                    List(id2Automaton(aut1).get,
                                         id2Automaton(aut2.complement).get)))
      }
    } else if (aut1.id > aut2.id) {
      isSubsetOf(aut2.complement, aut1.complement)
    } else {
      true
    }

  /**
   * Check whether aut1 specifies a subset of aut2;
   * the check is only carried out when all required automata are already in
   * the database.
   */
  def isSubsetOfBE(aut1 : NamedAutomaton,
                   aut2 : NamedAutomaton) : Option[Boolean] =
    if (aut1.id < aut2.id) {
      synchronized {
        // aut1 <= aut2
        //  <==>
        // (aut1 & aut2.complement) = empty
        for (a1 <- id2AutomatonBE(aut1);
             a2 <- id2AutomatonBE(aut2.complement)) yield 
          subsetRel.getOrElseUpdate((aut1, aut2),
                                    !AutomataUtils.areConsistentAutomata(
                                      List(a1, a2)))
      }
    } else if (aut1.id > aut2.id) {
      isSubsetOfBE(aut2.complement, aut1.complement)
    } else {
      Some(true)
    }

  /**
   * Check whether aut1 and aut2 have empty
   * intersection.
   */
  def emptyIntersection(aut1 : NamedAutomaton,
                        aut2 : NamedAutomaton) : Boolean =
    isSubsetOf(aut1, aut2.complement)

  /**
   * Query the automaton that belongs to a regular expression.
   */
  def regex2Automaton(regexTerm : ITerm) : Automaton =
    id2Automaton(regex2Id(regexTerm)).get

  /**
   * Query the complemented automaton that belongs to a regular expression.
   */
  def regex2ComplementedAutomaton(regexTerm : ITerm) : Automaton =
    id2ComplementedAutomaton(regex2Id(regexTerm)).get

}