Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The rlc Reference Manual

This is the rlc Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:36:33 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The rlc Reference Manual, Up: The rlc Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The rlc Reference Manual [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.

rlc

Previous: Systems, Up: Systems [Contents][Index]

2.1 `rlc`

Dependency

kmrcl (system).

Source

Child Components

package.lisp (file).
main.lisp (file).

Next: Packages, Previous: Systems, Up: The rlc Reference Manual [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

rlc/rlc.asd
rlc/package.lisp
rlc/main.lisp

Next: rlc/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `rlc/rlc.asd`

Source: rlc.asd.
Parent Component: rlc (system).
ASDF Systems: rlc.
Packages: rlc-system.

Next: rlc/main.lisp, Previous: rlc/rlc.asd, Up: Lisp [Contents][Index]

3.1.2 `rlc/package.lisp`

Source: rlc.asd.
Parent Component: rlc (system).
Packages: rlc.

Previous: rlc/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `rlc/main.lisp`

Dependency

package.lisp (file).

Source

Parent Component

rlc (system).

Public Interface

plot-series-rlc-current (function).
series-rlc-current-formula (function).
series-rlc-current-time (function).
write-series-rlc-current-graph-stream (function).

Internals

circuit-type (function).
run-xgraph (function).
series-rlc-current-graph-data (function).
write-series-rlc-current-graph (function).

Next: Definitions, Previous: Files, Up: The rlc Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

rlc
rlc-system

Next: rlc-system, Previous: Packages, Up: Packages [Contents][Index]

4.1 `rlc`

Source

package.lisp.

Use List

common-lisp.

Public Interface

plot-series-rlc-current (function).
series-rlc-current-formula (function).
series-rlc-current-time (function).
write-series-rlc-current-graph-stream (function).

Internals

circuit-type (function).
run-xgraph (function).
series-rlc-current-graph-data (function).
write-series-rlc-current-graph (function).

Previous: rlc, Up: Packages [Contents][Index]

4.2 `rlc-system`

Source

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The rlc Reference Manual [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: plot-series-rlc-current (v r l c t-inc t-end &optional t-start graph-function) ¶

Package: rlc.
Source: main.lisp.

Function: series-rlc-current-formula (v r l c) ¶

Returns formula for currrent through a series RLC circuit with a step-voltage applied at time 0.

Package: rlc.
Source: main.lisp.

Function: series-rlc-current-time (v r l c tm) ¶

Package: rlc.
Source: main.lisp.

Function: write-series-rlc-current-graph-stream (out v r l c t-inc t-end &optional t-start) ¶

Package: rlc.
Source: main.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Ordinary functions

Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Ordinary functions

Function: circuit-type (r l c) ¶

Package: rlc.
Source: main.lisp.

Function: run-xgraph (path) ¶

Package: rlc.
Source: main.lisp.

Function: series-rlc-current-graph-data (v r l c t-inc t-end &optional t-start) ¶

Package: rlc.
Source: main.lisp.

Function: write-series-rlc-current-graph (path v r l c t-inc t-end &optional t-start) ¶

Package: rlc.
Source: main.lisp.

Previous: Definitions, Up: The rlc Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	C F P R S W

	Index Entry		Section

C
	`circuit-type`:		Private ordinary functions

F
	`Function, circuit-type`:		Private ordinary functions
	`Function, plot-series-rlc-current`:		Public ordinary functions
	`Function, run-xgraph`:		Private ordinary functions
	`Function, series-rlc-current-formula`:		Public ordinary functions
	`Function, series-rlc-current-graph-data`:		Private ordinary functions
	`Function, series-rlc-current-time`:		Public ordinary functions
	`Function, write-series-rlc-current-graph`:		Private ordinary functions
	`Function, write-series-rlc-current-graph-stream`:		Public ordinary functions

P
	`plot-series-rlc-current`:		Public ordinary functions

R
	`run-xgraph`:		Private ordinary functions

S
	`series-rlc-current-formula`:		Public ordinary functions
	`series-rlc-current-graph-data`:		Private ordinary functions
	`series-rlc-current-time`:		Public ordinary functions

W
	`write-series-rlc-current-graph`:		Private ordinary functions
	`write-series-rlc-current-graph-stream`:		Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	F M P R S

	Index Entry		Section

F
	`File, main.lisp`:		The rlc/main․lisp file
	`File, package.lisp`:		The rlc/package․lisp file
	`File, rlc.asd`:		The rlc/rlc․asd file

M
	`main.lisp`:		The rlc/main․lisp file

P
	`Package, rlc`:		The rlc package
	`Package, rlc-system`:		The rlc-system package
	`package.lisp`:		The rlc/package․lisp file

R
	`rlc`:		The rlc system
	`rlc`:		The rlc package
	`rlc-system`:		The rlc-system package
	`rlc.asd`:		The rlc/rlc․asd file

S
	`System, rlc`:		The rlc system