"""Sampling Graphs."""

from typing import Dict, Union


__all__ = ["SamplingGraph"]


class SamplingGraph:
    r"""Class for sampling graph."""

    def __init__(self):
        pass

    @property
    def num_nodes(self) -> Union[int, Dict[str, int]]:
        """The number of nodes in the graph.
        - If the graph is homogenous, returns an integer.
        - If the graph is heterogenous, returns a dictionary.

        Returns
        -------
        Union[int, Dict[str, int]]
            The number of nodes. Integer indicates the total nodes number of a
            homogenous graph; dict indicates nodes number per node types of a
            heterogenous graph.
        """
        raise NotImplementedError
