protocol

# profilerp

> Simple wrapper protocol for Prolog native profilers.

author:
  `Paulo Moura`
version:
  `1.01`
date:
  `2013/1/11`

compilation flags:
  `static`

(no dependencies on other files)

## Public interface

### load/1

> Compiles and loads a Logtalk source file for profiling.

compilation flags:
  `static`
template:
  `load(File)`
mode – number of proofs:
  `load(@file) – zero_or_one`

### load/2

> Compiles and loads a Logtalk source file for profiling using a set of options.

compilation flags:
  `static`
template:
  `load(File,Options)`
mode – number of proofs:
  `load(@file,@list) – zero_or_one`

### profile/1

> Proves a goal while collecting profiling information.

compilation flags:
  `static`
template:
  `profile(Goal)`
meta-predicate template:
  `profile(0)`
mode – number of proofs:
  `profile(@callable) – zero_or_more`

### data/0

> Prints a table with all profiling data.

compilation flags:
  `static`
mode – number of proofs:
  `data – one`

### data/1

> Prints a table with all profiling data for a given entity.

compilation flags:
  `static`
template:
  `data(Entity)`
mode – number of proofs:
  `data(@entity_identifier) – one`

### reset/0

> Resets all profiling data.

compilation flags:
  `static`
mode – number of proofs:
  `reset – one`

## Protected interface

(none)

## Private predicates

(none)

## Operators

### (none)

## Remarks

### (none)