github.com/gopherd/gonum@v0.0.4/graph/product/doc.go (about)

     1  // Copyright ©2019 The Gonum Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  // Package product implements graph product functions.
     6  //
     7  // All the graph products in this package are graphs with order
     8  // n₁n₂ where n₁ and n₂ are the orders of the input graphs. This is
     9  // the order of the set of the Cartesian product of the two input
    10  // graphs' nodes.
    11  //
    12  // The nodes of the product hold the original input graphs' nodes
    13  // in the A and B fields in product.Nodes. This allows a mapping
    14  // between the input graphs and their products.
    15  //
    16  // See https://en.wikipedia.org/wiki/Graph_product for more details
    17  // about graph products.
    18  package product // import "github.com/gopherd/gonum/graph/product"