Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
KOSMOS 0.3.1 Documentation
KOSMOS 0.3.1 Documentation

User Guide

  • Getting started
  • Examples
    • Machine Learning Examples
      • Centralized Learning
        • Centralized Learning – Variational Quantum Circuits
        • Centralized Learning – Neural Networks
      • Federated Learning
        • Federated Learning – Variational Quantum Circuits
        • Federated Learning – Neural Networks
    • Routing Examples

API Documentation

  • kosmos.ml
    • kosmos.ml.config
      • kosmos.ml.config.factories
        • kosmos.ml.config.factories.encoding
        • kosmos.ml.config.factories.loss
        • kosmos.ml.config.factories.lr_scheduler
        • kosmos.ml.config.factories.model
        • kosmos.ml.config.factories.optimizer
      • kosmos.ml.config.sl_train
    • kosmos.ml.datasets
      • kosmos.ml.datasets.banknote_dataset
      • kosmos.ml.datasets.dataset
      • kosmos.ml.datasets.digits_dataset
      • kosmos.ml.datasets.fashion_dataset
      • kosmos.ml.datasets.income_dataset
      • kosmos.ml.datasets.iris_dataset
      • kosmos.ml.datasets.mnist_dataset
      • kosmos.ml.datasets.qsar_dataset
      • kosmos.ml.datasets.wdbc_dataset
      • kosmos.ml.datasets.wine_dataset
    • kosmos.ml.fl
      • kosmos.ml.fl.fl_client
      • kosmos.ml.fl.fl_manager
      • kosmos.ml.fl.fl_server
    • kosmos.ml.models
      • kosmos.ml.models.vqc
        • kosmos.ml.models.vqc.circuit
        • kosmos.ml.models.vqc.encoding
        • kosmos.ml.models.vqc.vqc
      • kosmos.ml.models.model
      • kosmos.ml.models.neural_network
    • kosmos.ml.cl_manager
    • kosmos.ml.dataloader
    • kosmos.ml.sl_metrics
    • kosmos.ml.sl_result
    • kosmos.ml.sl_trainer
    • kosmos.ml.typing
  • kosmos.protocols
    • kosmos.protocols.config
      • kosmos.protocols.config.protocol
    • kosmos.protocols.routing
      • kosmos.protocols.routing.dijkstra_routing
      • kosmos.protocols.routing.path
      • kosmos.protocols.routing.routing
    • kosmos.protocols.eg_protocol
    • kosmos.protocols.protocol
    • kosmos.protocols.protocol_result
    • kosmos.protocols.status
  • kosmos.quantum_logic
    • kosmos.quantum_logic.entanglement_link
    • kosmos.quantum_logic.quantum_register_manager
    • kosmos.quantum_logic.quantum_state
    • kosmos.quantum_logic.qubit
    • kosmos.quantum_logic.typing
  • kosmos.simulator
    • kosmos.simulator.fl_simulator
    • kosmos.simulator.simulator
  • kosmos.topology
    • kosmos.topology.link
    • kosmos.topology.net
    • kosmos.topology.node
    • kosmos.topology.typing
  • kosmos.utils
    • kosmos.utils.rng
Back to top
View this page

kosmos.topology.link¶

Classes¶

class LinkId¶

Identifier of a link.

value¶

Identifier string.

Type:

str


class LinkType(*args, **kwds)¶

Bases: enum.Enum

Type of link.


class Link¶

Bases: abc.ABC

Base for undirected links between two nodes.

id¶

Link identifier.

Type:

LinkId

label¶

Label of the link. Defaults to None.

Type:

str | None

src¶

Source node.

Type:

Node

dst¶

Destination node.

Type:

Node


Properties

property type¶

Type of the link.

property weight¶

Cost of the link.


class OpticalLink¶

Bases: Link

Base for optical fiber links.

id¶

Link identifier.

Type:

LinkId

label¶

Label of the link. Defaults to None.

Type:

str | None

src¶

Source node.

Type:

Node

dst¶

Destination node.

Type:

Node

distance¶

Length of the fiber in meters.

Type:

float

attenuation¶

Attenuation of the fiber in dB/m.

Type:

float

signal_speed¶

Propagation speed in m/ps.

Type:

float


Properties

property delay¶

Propagation delay in ps.

property total_attenuation¶

Total attenuation in dB.

property transmissivity¶

Transmitted fraction.

property loss¶

Loss rate for transmitted photons.

property type¶

Type of the link.

property weight¶

Cost of the link.


class ClassicalLink¶

Bases: OpticalLink

Classical optical fiber link.

id¶

Link identifier.

Type:

LinkId

label¶

Label of the link. Defaults to None.

Type:

str | None

src¶

Source node.

Type:

Node

dst¶

Destination node.

Type:

Node

distance¶

Length of the fiber in meters.

Type:

float

attenuation¶

Attenuation of the fiber in dB/m.

Type:

float

signal_speed¶

Propagation speed in m/ps.

Type:

float

bandwidth¶

Link bandwidth in bit/s.

Type:

float


Properties

property type¶

Type of the link.

property weight¶

Heuristic cost of the classical link.

property delay¶

Propagation delay in ps.

property total_attenuation¶

Total attenuation in dB.

property transmissivity¶

Transmitted fraction.

property loss¶

Loss rate for transmitted photons.


class QuantumLink¶

Bases: OpticalLink

Quantum optical fiber link.

id¶

Link identifier.

Type:

LinkId

label¶

Label of the link. Defaults to None.

Type:

str | None

src¶

Source node.

Type:

Node

dst¶

Destination node.

Type:

Node

distance¶

Length of the fiber in meters.

Type:

float

attenuation¶

Attenuation of the fiber in dB/m.

Type:

float

signal_speed¶

Propagation speed in m/ps.

Type:

float

polarization_fidelity¶

Probability of no polarization error. Defaults to 1.0.

Type:

float

repetition_rate¶

Photon generation repetition rate in Hz.

Type:

float


Properties

property type¶

Type of the link.

property weight¶

Heuristic cost of the quantum link.

property delay¶

Propagation delay in ps.

property total_attenuation¶

Total attenuation in dB.

property transmissivity¶

Transmitted fraction.

property loss¶

Loss rate for transmitted photons.

Next
kosmos.topology.net
Previous
kosmos.topology
Copyright © 2025, AIGNOSCO GmbH
Made with Sphinx and @pradyunsg's Furo
On this page
  • kosmos.topology.link
    • Classes
      • LinkId
        • LinkId.value
      • LinkType
      • Link
        • Link.id
        • Link.label
        • Link.src
        • Link.dst
        • Link.type
        • Link.weight
      • OpticalLink
        • OpticalLink.id
        • OpticalLink.label
        • OpticalLink.src
        • OpticalLink.dst
        • OpticalLink.distance
        • OpticalLink.attenuation
        • OpticalLink.signal_speed
        • OpticalLink.delay
        • OpticalLink.total_attenuation
        • OpticalLink.transmissivity
        • OpticalLink.loss
        • OpticalLink.type
        • OpticalLink.weight
      • ClassicalLink
        • ClassicalLink.id
        • ClassicalLink.label
        • ClassicalLink.src
        • ClassicalLink.dst
        • ClassicalLink.distance
        • ClassicalLink.attenuation
        • ClassicalLink.signal_speed
        • ClassicalLink.bandwidth
        • ClassicalLink.type
        • ClassicalLink.weight
        • ClassicalLink.delay
        • ClassicalLink.total_attenuation
        • ClassicalLink.transmissivity
        • ClassicalLink.loss
      • QuantumLink
        • QuantumLink.id
        • QuantumLink.label
        • QuantumLink.src
        • QuantumLink.dst
        • QuantumLink.distance
        • QuantumLink.attenuation
        • QuantumLink.signal_speed
        • QuantumLink.polarization_fidelity
        • QuantumLink.repetition_rate
        • QuantumLink.type
        • QuantumLink.weight
        • QuantumLink.delay
        • QuantumLink.total_attenuation
        • QuantumLink.transmissivity
        • QuantumLink.loss