chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package aop
  Definition Classes
    chisel3
- ActualDirection
- Aggregate
- AliasedAggregateFieldException
- AsyncReset
- AutoClonetypeException
- BiConnectException
- Binary
- BindingException
- Bits
- Bits
- BlackBox
- Bool
- Bool
- BoolFactory
- BuildInfo
- Bundle
- Character
- ChiselEnum
- ChiselException
- Clock
- Const
- Data
- Decimal
- Disable
- DontCare
- Element
- EnumType
- ExpectedAnnotatableException
- ExpectedChiselTypeException
- ExpectedHardwareException
- FirrtlFormat
- FixedIOBaseModule
- FixedIOExtModule
- FixedIORawModule
- FlatIO
- Flipped
- FullName
- HasTarget
- Hexadecimal
- IO
- IgnoreSeqInBundle
- ImplicitClock
- ImplicitReset
- Input
- InstanceId
- InternalErrorException
- KnownWidth
- Mem
- MemBase
- MixedDirectionAggregateException
- Module
- ModuleAspect
- MonoConnectException
- Mux
- Name
- Num
- NumObject
- Output
- PString
- Percent
- Printable
- PrintableHelper
- Printables
- RawModule
- RebindingException
- Record
- Reg
- RegInit
- RegNext
- RequireAsyncReset
- RequireSyncReset
- Reset
- ResetType
- SInt
- SInt
- SIntFactory
- SourceInfoDoc
- SpecifiedDirection
- SyncReadMem
- UInt
- UInt
- UIntFactory
- UnknownWidth
- Vec
- Vec
- VecFactory
- VecInit
- VecLike
- VerifPrintMacrosDoc
- VerificationStatement
- WhenContext
- Width
- Wire
- WireDefault
- WireFactory
- WireInit
- assert
- assume
- chiselTypeOf
- cover
- dontTouch
- emitVerilog
- fromBigIntToLiteral
- fromBooleanToLiteral
- fromIntToLiteral
- fromIntToWidth
- fromLongToLiteral
- fromStringToLiteral
- getVerilogString
- layer
- printf
- stop
- suppressEnumCastWarning
- when
- withClock
- withClockAndReset
- withDisable
- withReset
- withoutIO
-  package choice

  This package contains Chisel language definitions for describing configuration options and their accepted values.

  This package contains Chisel language definitions for describing configuration options and their accepted values.

  Definition Classes
    chisel3
-  package connectable
  Definition Classes
    chisel3
-  package experimental

  Package for experimental features, which may have their API changed, be removed, etc.

  Package for experimental features, which may have their API changed, be removed, etc.

  Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.

  Definition Classes
    chisel3
-  package interface
  Definition Classes
    chisel3
-  package ltl
  Definition Classes
    chisel3
-  package naming
  Definition Classes
    chisel3
-  package probe
  Definition Classes
    chisel3
-  package properties

  The properties package includes functionality related to non-hardware data.

  The properties package includes functionality related to non-hardware data.

  This entire package is currently very experimental, so expect some rough edges and rapid API evolution.

  Definition Classes
    chisel3
-  package reflect
  Definition Classes
    chisel3
-  package simulator
  Definition Classes
    chisel3
-  package stage
  Definition Classes
    chisel3
-  package std
  Definition Classes
    chisel3
-  package testers

  The testers package provides the basic interface for chisel testers.

  The testers package provides the basic interface for chisel testers.

  Definition Classes
    chisel3
-  package util

  The util package provides extensions to core chisel for common hardware components and utility functions

  The util package provides extensions to core chisel for common hardware components and utility functions

  Definition Classes
    chisel3

o

chisel3

# assume

###

#### object assume extends VerifPrintMacrosDoc

Source
  VerificationStatement.scala

Linear Supertypes
VerifPrintMacrosDoc, AnyRef, Any

Ordering

1. Grouped
2. Alphabetic
3. By Inheritance

Inherited

1. assume
2. VerifPrintMacrosDoc
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Type Members

1.  final class Assume extends VerificationStatement

   Named class for assumptions.

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  def _applyMacroWithInterpolatorCheck(c: Context)(cond: scala.reflect.macros.blackbox.Context.Tree, message: scala.reflect.macros.blackbox.Context.Tree, data: scala.reflect.macros.blackbox.Context.Tree*)(sourceInfo: scala.reflect.macros.blackbox.Context.Tree): scala.reflect.macros.blackbox.Context.Tree

5.  def _applyMacroWithNoMessage(c: Context)(cond: scala.reflect.macros.blackbox.Context.Tree)(sourceInfo: scala.reflect.macros.blackbox.Context.Tree): scala.reflect.macros.blackbox.Context.Tree

6.  def _applyMacroWithPrintableMessage(c: Context)(cond: scala.reflect.macros.blackbox.Context.Tree, message: scala.reflect.macros.blackbox.Context.Tree)(sourceInfo: scala.reflect.macros.blackbox.Context.Tree): scala.reflect.macros.blackbox.Context.Tree

7.  def _applyMacroWithStringMessage(c: Context)(cond: scala.reflect.macros.blackbox.Context.Tree, message: scala.reflect.macros.blackbox.Context.Tree, data: scala.reflect.macros.blackbox.Context.Tree*)(sourceInfo: scala.reflect.macros.blackbox.Context.Tree): scala.reflect.macros.blackbox.Context.Tree

8.  def _applyWithSourceLine(cond: Bool, line: SourceLineInfo, message: Option[String], data: Bits*)(implicit sourceInfo: SourceInfo): Assume

   This will be removed in Chisel 3.6 in favor of the Printable version

9.  def _applyWithSourceLinePrintable(cond: Bool, line: SourceLineInfo, message: Option[Printable])(implicit sourceInfo: SourceInfo): Assume

10.  def apply(cond: Boolean): Unit

    An elaboration-time assumption.

    An elaboration-time assumption. Calls the built-in Scala assume function.

11.  def apply(cond: Boolean, message: => String): Unit

    An elaboration-time assumption.

    An elaboration-time assumption. Calls the built-in Scala assume function.

12.  macro def apply(cond: Bool)(implicit sourceInfo: SourceInfo): Assume
13.  macro def apply(cond: Bool, message: Printable)(implicit sourceInfo: SourceInfo): Assume

    Assumes a condition to be valid in the circuit at all times.

    Assumes a condition to be valid in the circuit at all times. Acts like an assertion in simulation and imposes a declarative assumption on the state explored by formal tools.

    Does not fire when in reset (defined as the encapsulating Module's reset). If your definition of reset is not the encapsulating Module's reset, you will need to gate this externally.

    May be called outside of a Module (like defined in a function), so functions using assert make the standard Module assumptions (single clock and single reset).

    cond

      condition, assertion fires (simulation fails) when false

    message

      optional Printable type message when the assertion fires

    Note

      See printf.apply(pable:chisel3\.Printable)* for documentation on printf using Printables

14.  macro def apply(cond: Bool, message: String, data: Bits*)(implicit sourceInfo: SourceInfo): Assume

    Assumes a condition to be valid in the circuit at all times.

    Assumes a condition to be valid in the circuit at all times. Acts like an assertion in simulation and imposes a declarative assumption on the state explored by formal tools.

    Does not fire when in reset (defined as the encapsulating Module's reset). If your definition of reset is not the encapsulating Module's reset, you will need to gate this externally.

    May be called outside of a Module (like defined in a function), so functions using assert make the standard Module assumptions (single clock and single reset).

    cond

      condition, assertion fires (simulation fails) when false

    message

      optional format string to print when the assertion fires

    data

      optional bits to print in the message formatting

    Note

      See printf for format string documentation

15.  final def asInstanceOf[T0]: T0
    Definition Classes
      Any
16.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
17.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
18.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
19.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
20.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
21.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
22.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
23.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
24.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
25.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
26.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
27.  def toString(): String
    Definition Classes
      AnyRef → Any
28.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
29.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
30.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Inherited from VerifPrintMacrosDoc

### Inherited from AnyRef

### Inherited from Any

### Ungrouped

### VerifPrintMacros

These internal methods are not part of the public-facing API!