/// <summary>
/// Writes comments of a GOM class to 'SB'.
/// </summary>
/// <param name="SB">Where the comment goes.</param>
/// <param name="S">Used for basis vector names and output language.</param>
/// <param name="cgd">Intermediate data for code generation. Also contains plugins and cog.</param>
/// <param name="FT">Float point type of 'GOM'.</param>
/// <param name="gom">The general outermorphism for which the class should be written.</param>
public static void WriteComment(StringBuilder SB, Specification S, G25.CG.Shared.CGdata cgd, FloatType FT, G25.GOM gom)
{
SB.AppendLine("/**");
SB.AppendLine(" * This class can hold a general outermorphism.");
SB.AppendLine(" * ");
SB.AppendLine(" * The coordinates are stored in type " + FT.type + ".");
SB.AppendLine(" * ");
SB.AppendLine(" * There are " + gom.Domain.Length + " matrices, one for each grade.");
SB.AppendLine(" * The columns of these matrices are the range of the outermorphism.");
SB.AppendLine(" * Matrices are stored in row-major order. So the coordinates of rows are stored contiguously.");
for (int g = 1; g < gom.Domain.Length; g++) // start at '1' in order to skip scalar grade
{
SB.Append(" * Domain grade " + g + ": ");
for (int i = 0; i < gom.DomainForGrade(g).Length; i++)
{
if (i > 0) SB.Append(", ");
SB.Append(gom.DomainForGrade(g)[i].ToString(S.m_basisVectorNames));
}
SB.AppendLine(".");
}
SB.AppendLine(" * ");
if (!gom.DomainAndRangeAreEqual())
{
for (int g = 1; g < gom.Range.Length; g++) // start at '1' in order to skip scalar grade
{
SB.Append(" * Range grade " + g + ": ");
for (int i = 0; i < gom.RangeForGrade(g).Length; i++)
{
if (i > 0) SB.Append(", ");
SB.Append(gom.RangeForGrade(g)[i].ToString(S.m_basisVectorNames));
}
SB.AppendLine(".");
}
}
else SB.AppendLine(" * The range and domain are equal.");
SB.AppendLine(" * ");
SB.AppendLine(" */");
}
/// <summary>
/// Writes the definition of an SOM struct to 'SB' (including comments).
/// </summary>
/// <param name="SB">Where the code goes.</param>
/// <param name="S">Used for basis vector names and output language.</param>
/// <param name="cgd">Intermediate data for code generation. Also contains plugins and cog.</param>
/// <param name="FT">Float point type of 'SMV'.</param>
/// <param name="som">The general outermorphism for which the struct should be written.</param>
public static void WriteSOMstruct(StringBuilder SB, Specification S, G25.CG.Shared.CGdata cgd, FloatType FT, G25.SOM som)
{
SB.AppendLine("");
{ // comments for type:
SB.AppendLine("/**");
SB.AppendLine(" * This struct can hold a specialized outermorphism.");
SB.AppendLine(" * ");
SB.AppendLine(" * The coordinates are stored in type " + FT.type + ".");
SB.AppendLine(" * ");
SB.AppendLine(" * There are " + som.Domain.Length + " matrices, one for each grade.");
SB.AppendLine(" * The columns of these matrices are the range of the outermorphism.");
SB.AppendLine(" * Matrices are stored in row-major order. So the coordinates of rows are stored contiguously.");
for (int g = 1; g < som.Domain.Length; g++) // start at '1' in order to skip scalar grade
{
SB.Append(" * Domain grade " + g + ": ");
for (int i = 0; i < som.DomainForGrade(g).Length; i++)
{
if (i > 0) SB.Append(", ");
SB.Append(som.DomainForGrade(g)[i].ToString(S.m_basisVectorNames));
}
SB.AppendLine(".");
}
SB.AppendLine(" * ");
if (!som.DomainAndRangeAreEqual())
{
for (int g = 1; g < som.Range.Length; g++) // start at '1' in order to skip scalar grade
{
SB.Append(" * Range grade " + g + ": ");
for (int i = 0; i < som.RangeForGrade(g).Length; i++)
{
if (i > 0) SB.Append(", ");
SB.Append(som.RangeForGrade(g)[i].ToString(S.m_basisVectorNames));
}
SB.AppendLine(".");
}
}
else SB.AppendLine(" * The range and domain are equal.");
SB.AppendLine(" * ");
SB.AppendLine(" */");
} // end of comment
// typedef
SB.AppendLine("typedef struct ");
SB.AppendLine("{");
for (int g = 1; g < som.Domain.Length; g++) // start at '1' in order to skip scalar grade
{
if (!som.EmptyGrade(g))
{
SB.AppendLine("\t/** Matrix for grade " + g + "; the size is " + som.DomainForGrade(g).Length + " x " + som.RangeForGrade(g).Length + " */");
SB.AppendLine("\t" + FT.type + " m" + g + "[" +
som.DomainForGrade(g).Length * som.RangeForGrade(g).Length + "];");
}
}
SB.AppendLine("} " + FT.GetMangledName(S, som.Name) + ";");
}
/// <summary>
/// Returns the comment for the SOM class.
/// </summary>
/// <param name="S">Used for basis vector names and output language.</param>
/// <param name="cgd">Intermediate data for code generation. Also contains plugins and cog.</param>
/// <param name="FT">Float point type of 'GOM'.</param>
/// <param name="som">The general outermorphism for which the class should be written.</param>
public static Comment GetSomComment(Specification S, G25.CG.Shared.CGdata cgd, FloatType FT, G25.SOM som)
{
StringBuilder SB = new StringBuilder();
SB.AppendLine("This class can hold a specialized outermorphism.");
SB.AppendLine();
SB.AppendLine("The coordinates are stored in type " + FT.type + ".");
SB.AppendLine();
SB.AppendLine("There are " + som.Domain.Length + " matrices, one for each grade.");
SB.AppendLine("The columns of these matrices are the range of the outermorphism.");
SB.AppendLine("Matrices are stored in row-major order. So the coordinates of rows are stored contiguously.");
for (int g = 1; g < som.Domain.Length; g++) // start at '1' in order to skip scalar grade
{
SB.Append("Domain grade " + g + ": ");
for (int i = 0; i < som.DomainForGrade(g).Length; i++)
{
if (i > 0) SB.Append(", ");
SB.Append(som.DomainForGrade(g)[i].ToString(S.m_basisVectorNames));
}
SB.AppendLine(".");
}
SB.AppendLine();
if (!som.DomainAndRangeAreEqual())
{
for (int g = 1; g < som.Range.Length; g++) // start at '1' in order to skip scalar grade
{
SB.Append("Range grade " + g + ": ");
for (int i = 0; i < som.RangeForGrade(g).Length; i++)
{
if (i > 0) SB.Append(", ");
SB.Append(som.RangeForGrade(g)[i].ToString(S.m_basisVectorNames));
}
SB.AppendLine(".");
}
}
else SB.AppendLine("The range and domain are equal.");
return new Comment(SB.ToString());
}
