Skip to content

Commit

Permalink
Atualizando documentação
Browse files Browse the repository at this point in the history
  • Loading branch information
richecr committed Nov 1, 2019
1 parent deb3fa4 commit e3ba2ad
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 4 deletions.
33 changes: 32 additions & 1 deletion docs/graphs/graph.md
@@ -1 +1,32 @@
# Grafo Base
# Grafo Base
Esse é o grafo que todos os outros grafos vão herdar, algumas de suas características/métodos.

Esse grafo não possui nenhum tipo de restrição. Pois todos os outros grafos vão herdar e sobrescrever os métodos necessários.

## Métodos:

| Nome do vertice | parametros | O que faz | Retorno |
----------------- | ---------- | --------- |--------- |
| addVertex | value | Método que adiciona um vértice ao grafo. | SimpleVertex adicionado |
| delete_vertex | value | Método que remove um vertice do grafo e consequentemente todas as arestas conectadas ao vertice. | SimpleVertex removido |
| add_edge | value_a, value_b, name(opcional) | Método que adiciona uma aresta ao grafo. | SimpleEdge adicionado. |
| delete_edge | value_a, value_b | Método que remove uma aresta do grafo. | SimpleEdge removido. |
| show_edge | value_a, value_b | Método que retorna uma aresta entre dois vértices, se ela existe. | SimpleEdge. |
| is_terminal | edge, value | Método que verifica se um dado vértice é terminal de uma dada aresta. | Boolean |
| num_vertex | --- | Método que retorna o número de vértices no grafo. | Integer |
| num_edges | --- | Método que retorna o número de arestas no grafo. | Integer |
| vertex_exists | value | Método que indica se um determinado vértice pertence ao Grafo. | Boolean |
| edge_exists | value_a, value_b | Método que indica se uma determinada aresta pertence ao Grafo. | Boolean |
| vertex_neighbors | value | Método que encontra vertices vizinhos do vertice de entrada. | List |
| vertex_degree | value | Método que retorna o grau do vértice de entrada. | Integer |
| is_vertices_adjacents | value_a, value_b | Método que indica se os vértices de entrada são adjacentes. | Boolean |
| get_all_vertex | --- | Método que retorna uma lista com os vértices do grafo. | List |
| list_graph_vertices | --- | Método que retorna lista com todos os identificadores dos vértices do grafo. | List |
| list_graph_edges | --- | Método que retorna lista com todos os nomes as arestas do grafo. | List |
| cycle | v, visited, parent | Método que verifica se tem ciclo no subgrafo a partir do vértice v. | Boolean |
| has_cycle | --- | Método que verifica se o grafo possui um ciclo. Loops também são detectados. | Boolean |
| has_loop | --- | Método que verifica se o grafo possui um loop. | Boolean |
| check_regular_graph | --- | Método que verifica a regularidade de um grafo. | Boolean |
| incidence_list | --- | Método que retorna uma lista de objetos que contem a incidencia dos vertices com as arestas. | List<ValueBinding> |
| adjacency_matrix | --- | Método que retorna a representação em forma de matriz de adjacência do grafo. | Dict |
| __str __ | --- | Método que retorna a representação textual do grafo. | String |
8 changes: 5 additions & 3 deletions py_graph_t/Graph.py
Expand Up @@ -294,7 +294,8 @@ def list_graph_vertices(self):
Retorno:
----------
vertices: lista com o nome de todas os vértices do grafo.
vertices: List
- Lista com o nome de todas os vértices do grafo.
"""
vertices = []
for vertex in self.vertices:
Expand All @@ -308,7 +309,8 @@ def list_graph_edges(self):
Retorno:
----------
edges: lista com o nome de todas as arestas do grafo.
edges: List
- Lista com o nome de todas as arestas do grafo.
"""
edges = []
for edge in self.edges:
Expand Down Expand Up @@ -385,7 +387,7 @@ def has_loop(self):

def check_regular_graph(self):
"""
Função que verifica a regularidade de um grafo.
Método que verifica a regularidade de um grafo.
Retorno:
----------
Expand Down

0 comments on commit e3ba2ad

Please sign in to comment.