qiskit-documentation/docs/api/qiskit/0.31/qiskit.chemistry.results.VibronicStructureResult.mdx

---
title: VibronicStructureResult
description: API reference for qiskit.chemistry.results.VibronicStructureResult
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.chemistry.results.VibronicStructureResult
---

# VibronicStructureResult

<Class id="qiskit.chemistry.results.VibronicStructureResult" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/results/vibronic_structure_result.py" signature="VibronicStructureResult(a_dict=None)" modifiers="class">
  Bases: `qiskit.chemistry.results.eigenstate_result.EigenstateResult`

  The vibronic structure result.

  ## Methods

  ### clear

  <Function id="qiskit.chemistry.results.VibronicStructureResult.clear" signature="VibronicStructureResult.clear()">
    **Return type**

    `None`
  </Function>

  ### combine

  <Function id="qiskit.chemistry.results.VibronicStructureResult.combine" signature="VibronicStructureResult.combine(result)">
    Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set.

    **Raises**

    **TypeError** – Argument is None

    **Return type**

    `None`
  </Function>

  ### copy

  <Function id="qiskit.chemistry.results.VibronicStructureResult.copy" signature="VibronicStructureResult.copy()" />

  ### fromkeys

  <Function id="qiskit.chemistry.results.VibronicStructureResult.fromkeys" signature="VibronicStructureResult.fromkeys(iterable, value=None)" modifiers="classmethod" />

  ### get

  <Function id="qiskit.chemistry.results.VibronicStructureResult.get" signature="VibronicStructureResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None." />

  ### items

  <Function id="qiskit.chemistry.results.VibronicStructureResult.items" signature="VibronicStructureResult.items() → a set-like object providing a view on D’s items" />

  ### keys

  <Function id="qiskit.chemistry.results.VibronicStructureResult.keys" signature="VibronicStructureResult.keys() → a set-like object providing a view on D’s keys" />

  ### pop

  <Function id="qiskit.chemistry.results.VibronicStructureResult.pop" signature="VibronicStructureResult.pop(key, default=None)">
    If key is not found, d is returned if given, otherwise KeyError is raised.

    **Return type**

    `object`
  </Function>

  ### popitem

  <Function id="qiskit.chemistry.results.VibronicStructureResult.popitem" signature="VibronicStructureResult.popitem()">
    as a 2-tuple; but raise KeyError if D is empty.

    **Return type**

    `Tuple`\[`object`, `object`]
  </Function>

  ### setdefault

  <Function id="qiskit.chemistry.results.VibronicStructureResult.setdefault" signature="VibronicStructureResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D" />

  ### update

  <Function id="qiskit.chemistry.results.VibronicStructureResult.update" signature="VibronicStructureResult.update(*args, **kwargs)">
    If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v

    **Return type**

    `None`
  </Function>

  ### values

  <Function id="qiskit.chemistry.results.VibronicStructureResult.values" signature="VibronicStructureResult.values() → an object providing a view on D’s values" />

  ## Attributes

  ### algorithm\_result

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.algorithm_result">
    Returns raw algorithm result

    **Return type**

    `AlgorithmResult`
  </Attribute>

  ### aux\_operator\_eigenvalues

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.aux_operator_eigenvalues">
    return aux operator eigen values

    **Return type**

    `Optional`\[`List`\[`float`]]
  </Attribute>

  ### computed\_vibronic\_energies

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.computed_vibronic_energies">
    Returns computed electronic part of ground state energy

    **Return type**

    `ndarray`
  </Attribute>

  ### eigenenergies

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.eigenenergies">
    returns eigen energies

    **Return type**

    `Optional`\[`ndarray`]
  </Attribute>

  ### eigenstates

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.eigenstates">
    returns eigen states

    **Return type**

    `Optional`\[`List`\[`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]]]
  </Attribute>

  ### formatted

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.formatted">
    Formatted result as a list of strings

    **Return type**

    `List`\[`str`]
  </Attribute>

  ### groundenergy

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.groundenergy">
    returns ground energy

    **Return type**

    `Optional`\[`float`]
  </Attribute>

  ### groundstate

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.groundstate">
    returns ground state

    **Return type**

    `Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`, `None`]
  </Attribute>

  ### num\_occupied\_modals\_per\_mode

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.num_occupied_modals_per_mode">
    Returns the number of occupied modal per mode

    **Return type**

    `Optional`\[`List`\[`float`]]
  </Attribute>

  ### raw\_result

  <Attribute id="qiskit.chemistry.results.VibronicStructureResult.raw_result">
    Returns the raw algorithm result.

    **Return type**

    `Optional`\[`AlgorithmResult`]
  </Attribute>
</Class>