Mercurial > hg > truffle
diff truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/package-info.java @ 22501:a63bda98cfdb
Extract profiles into separate package. Add isProfilingEnabled in TruffleRuntime to disable profiling in the default runtime; Add low overhead profiles for primitives; Add LoopConditionProfile; Profile footprint/threadsafety improvements; Make toString implementations more consistent; Greatly enhanced javadoc documentation for profiles; Deprecate old profiles
| author | Christian Humer <christian.humer@oracle.com> |
|---|---|
| date | Wed, 16 Dec 2015 16:38:13 +0100 |
| parents | 2c65e6da65ea |
| children |
line wrap: on
line diff
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/package-info.java Wed Dec 16 12:31:17 2015 +0100 +++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/package-info.java Wed Dec 16 16:38:13 2015 +0100 @@ -28,8 +28,24 @@ group="To Review" ) */ - -/** Various utility methods. +/** + * Various utility classes that aim to make the development of TruffleLanguage guest + * languages easier. + * + * <p> + * We try to capture common language patterns in this package. Here is an overview of patterns that + * we have captured so far: + * <ul> + * <li>{@link com.oracle.truffle.api.utilities.AssumedValue} speculates on global values to remain + * unchanged.</li> + * <li>{@link com.oracle.truffle.api.utilities.CyclicAssumption} speculates on assumptions that + * might invalidate more often but are assumed to stabilize over time.</li> + * <li>{@link com.oracle.truffle.api.utilities.NeverValidAssumption} utility for assumptions that + * are always invalidated</li> + * <li>{@link com.oracle.truffle.api.utilities.UnionAssumption} utility for the union of two + * assumptions</li> + * </ul> + * </p> */ package com.oracle.truffle.api.utilities;