RnaStructureGraph - SeqAn API Documentation

# Class RnaStructureGraph
An undirected graph representing an RNA structure.

Defined in | <seqan/rna_io.h>
Signature | `class RnaStructureGraph;`

## Member Variable Overview

- `float RnaStructureGraph::energy`
  Energy of the RNA structure.
- `Graph<Undirected<double>> RnaStructureGraph::inter`
  Undirected graph for base pairings of the RNA structure.
- `CharString RnaStructureGraph::specs`
  Specs of the Method used to compute the bpp matrix or the structure.

## Detailed Description

Storage of a graph that contains base pairs and their probabilities of an RNA structure. The associated specs string describes the method that was used to obtain the RNA structure.

## Member Variables Detail

### `float RnaStructureGraph::energy`

Energy of the RNA structure.

### `Graph<Undirected<double>> RnaStructureGraph::inter`

Undirected graph for base pairings of the RNA structure.

The vertices denote the sequence/alignment column index. Edges are drawn among all pairing nucleotides. An edge's cargo represents the probability for the respective pairing.

### `CharString RnaStructureGraph::specs`

Specs of the Method used to compute the bpp matrix or the structure.

#### Dox Sources

    /*!
     * @class RnaStructureGraph
     *
     * @headerfile <seqan/rna_io.h>
     *
     * @brief An undirected graph representing an RNA structure.
     *
     * @signature class RnaStructureGraph;
     *
     * Storage of a graph that contains base pairs and their probabilities of an RNA
     * structure. The associated <i>specs</i> string describes the method that was
     * used to obtain the RNA structure.
     *
     * @var Graph<Undirected<double>> RnaStructureGraph::inter;
     *
     * @brief Undirected graph for base pairings of the RNA structure.
     *
     * The vertices denote the sequence/alignment column index. Edges are drawn
     * among all pairing nucleotides. An edge's cargo represents the probability for
     * the respective pairing.
     *
     * @var CharString RnaStructureGraph::specs;
     *
     * @brief Specs of the Method used to compute the bpp matrix or the structure.
     *
     * @var float RnaStructureGraph::energy;
     *
     * @brief Energy of the RNA structure.
     */