~ubuntu-branches/ubuntu/trusty/scotch/trusty-proposed

« back to all changes in this revision

Viewing changes to man/man1/amk_grf.1

  • Committer: Bazaar Package Importer
  • Author(s): "Adam C. Powell, IV", Christophe Trophime, Adam C. Powell, IV
  • Date: 2010-12-29 13:07:19 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20101229130719-jwalolw5d6av6wqx
Tags: 5.1.11.dfsg-1
[Christophe Trophime]
* New upstream release
* Forward-ported patches to version 5.1.10b.
* Install scotch headers properly.
* Fix chrpath commands in debian/rules.
* Fix (pt)scotch library install paths.
* Fix lintian errors and warnings.

[Adam C. Powell, IV]
* Forward-ported patches to version 5.1.11.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
." Text automatically generated by txt2man
 
2
.TH amk_grf 1 "August 03, 2010" "" "Scotch user's manual"
 
3
.SH NAME
 
4
\fBamk_grf \fP- create target architecture from source graph
 
5
\fB
 
6
.SH SYNOPSIS
 
7
.nf
 
8
.fam C
 
9
\fBamk_grf\fP [\fIoptions\fP] [\fIgfile\fP] [\fItfile\fP]
 
10
.fam T
 
11
.fi
 
12
.SH DESCRIPTION
 
13
The \fBamk_grf\fP program builds a decomposition-defined target
 
14
architecture \fItfile\fP from a source graph \fIgfile\fP.
 
15
.PP
 
16
Target architectures define the topology of the target graphs used
 
17
by static mapping programs \fBgmap\fP(1) and \fBdgmap\fP(1). Target
 
18
architectures can be either algorithmically-defined, for common,
 
19
regular topologies, or decomposition-defined, such as the ones
 
20
produced by \fBamk_grf\fP.
 
21
.PP
 
22
When the proper libraries have been included at compile time, \fBamk_grf\fP
 
23
can directly handle compressed files, both as input and output. A
 
24
stream is treated as compressed whenever its name is postfixed with
 
25
a compressed file extension, such as in 'brol.tgt.bz2' or '-.gz'. The
 
26
compression formats which can be supported are the bzip2 format
 
27
('.bz2'), the gzip format ('.gz'), and the lzma format ('.lzma', on
 
28
input only).
 
29
.PP
 
30
Since decomposition-defined target architecture files have a size
 
31
which is quadratic in the number of target vertices, because of the
 
32
presence of a distance matrix structure, using compressed files to
 
33
store them may save a lot of space.
 
34
.SH OPTIONS
 
35
.TP
 
36
.B
 
37
\fB-b\fP\fIstrat\fP
 
38
Apply bipartitioning strategy \fIstrat\fP to compute the
 
39
recursive bipartition of the whole source graph into
 
40
smaller target subdomains.
 
41
.TP
 
42
.B
 
43
\fB-h\fP
 
44
Display some help.
 
45
.TP
 
46
.B
 
47
\fB-l\fP\fIlfile\fP
 
48
Only keep vertices the indices of which belong to the
 
49
space-separated list stored in \fIlfile\fP. This allows one
 
50
to create target architectures which can even be
 
51
disjoint subsets of a larger target architecture,
 
52
modeled as a graph.
 
53
.TP
 
54
.B
 
55
\fB-V\fP
 
56
Display program version and copyright.
 
57
.SH EXAMPLE
 
58
Create a decomposition-defined target architecture from a 2D regular
 
59
grid source graph of dimension 3 times 5, and save it, as a compiled
 
60
target architecture, under the \fBgzip\fP(1) format, to file 'm3x5.tgt.gz'. 
 
61
.PP
 
62
.nf
 
63
.fam C
 
64
    $ gmk_m2 3 5 | amk_grf | acpl - m3x5.tgt.gz
 
65
 
 
66
.fam T
 
67
.fi
 
68
Note that, in this precise case, it would be much preferable to use
 
69
directly the 'mesh2D' algorithmically-defined target architecture.
 
70
.PP
 
71
.nf
 
72
.fam C
 
73
    $ echo "mesh2D 3 5" > m3x5.tgt
 
74
 
 
75
.fam T
 
76
.fi
 
77
.SH SEE ALSO
 
78
\fBacpl\fP(1), \fBamk_ccc\fP(1), \fBatst\fP(1), \fBdgmap\fP(1), \fBgmap\fP(1), \fBgmtst\fP(1).
 
79
.PP
 
80
Scotch user's manual.
 
81
.SH AUTHOR
 
82
Francois Pellegrini <francois.pellegrini@labri.fr>